pio 0.8.1 → 0.8.2

data/lib/pio/hello/format.rb

@@ -1,17 +1,17 @@
-# encoding: utf-8
-
 require 'bindata'
+require 'pio/open_flow'
 
 module Pio
-  class Hello
-    # OpenFlow 1.0 Hello message
+  class Hello < Pio::OpenFlow::Message
+    # OpenFlow 1.0 Hello message parser and generator.
     class Format < BinData::Record
+      include Pio::OpenFlow::Type
+
       endian :big
 
-      uint8 :ofp_version, value: 1
-      uint8 :message_type, initial_value: 0, assert: -> { value == 0 }
-      uint16 :message_length, initial_value: 8
-      uint32 :transaction_id
+      open_flow_header :open_flow_header, message_type_value: HELLO
+      virtual assert: -> { open_flow_header.message_type == HELLO }
+
       string :body  # ignored
     end
   end

data/lib/pio/icmp.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'pio/icmp/format'
 require 'pio/icmp/reply'
 require 'pio/icmp/request'

data/lib/pio/icmp/format.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'bindata'
 require 'pio/type/ethernet_header'
 require 'pio/type/ipv4_header'

data/lib/pio/icmp/message.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'pio/icmp/format'
 require 'forwardable'
 
@@ -9,40 +7,34 @@ module Pio
     class Message
       extend Forwardable
 
-      def_delegators :@frame, :destination_mac
-      def_delegators :@frame, :source_mac
-      def_delegators :@frame, :ether_type
-      def_delegators :@frame, :ip_version
-      def_delegators :@frame, :ip_header_length
-      def_delegators :@frame, :ip_type_of_service
-      def_delegators :@frame, :ip_total_length
-      def_delegators :@frame, :ip_identifier
-      def_delegators :@frame, :ip_flag
-      def_delegators :@frame, :ip_fragment
-      def_delegators :@frame, :ip_ttl
-      def_delegators :@frame, :ip_protocol
-      def_delegators :@frame, :ip_header_checksum
-      def_delegators :@frame, :ip_source_address
-      def_delegators :@frame, :ip_destination_address
-      def_delegators :@frame, :icmp_type
-      def_delegators :@frame, :icmp_code
-      def_delegators :@frame, :icmp_checksum
-      def_delegators :@frame, :icmp_identifier
-      def_delegators :@frame, :icmp_sequence_number
-      def_delegators :@frame, :echo_data
-      def_delegators :@frame, :to_binary
-
-      def self.create_from(frame)
-        message = allocate
-        message.instance_variable_set :@frame, frame
-        message
-      end
+      def_delegators :@format, :destination_mac
+      def_delegators :@format, :source_mac
+      def_delegators :@format, :ether_type
+      def_delegators :@format, :ip_version
+      def_delegators :@format, :ip_header_length
+      def_delegators :@format, :ip_type_of_service
+      def_delegators :@format, :ip_total_length
+      def_delegators :@format, :ip_identifier
+      def_delegators :@format, :ip_flag
+      def_delegators :@format, :ip_fragment
+      def_delegators :@format, :ip_ttl
+      def_delegators :@format, :ip_protocol
+      def_delegators :@format, :ip_header_checksum
+      def_delegators :@format, :ip_source_address
+      def_delegators :@format, :ip_destination_address
+      def_delegators :@format, :icmp_type
+      def_delegators :@format, :icmp_code
+      def_delegators :@format, :icmp_checksum
+      def_delegators :@format, :icmp_identifier
+      def_delegators :@format, :icmp_sequence_number
+      def_delegators :@format, :echo_data
+      def_delegators :@format, :to_binary
 
       private_class_method :new
 
       def initialize(user_options)
         options = self.class.const_get(:Options).new(user_options)
-        @frame = Icmp::Format.new(options.to_hash)
+        @format = Icmp::Format.new(options.to_hash)
       end
     end
   end

data/lib/pio/icmp/options.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'pio/options'
 
 module Pio

data/lib/pio/icmp/reply.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'pio/icmp/message'
 require 'pio/icmp/options'
 require 'pio/mac'
@@ -22,7 +20,7 @@ module Pio
         option :echo_data
 
         # rubocop:disable MethodLength
-
+        # rubocop:disable AbcSize
         def initialize(options)
           validate options
           @type = TYPE
@@ -36,7 +34,7 @@ module Pio
           @sequence_number = options[:sequence_number]
           @echo_data = options[:echo_data] || DEFAULT_ECHO_DATA
         end
-
+        # rubocop:enable AbcSize
         # rubocop:enable MethodLength
       end
     end

data/lib/pio/icmp/request.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'pio/icmp/message'
 require 'pio/icmp/options'
 require 'pio/mac'

data/lib/pio/ipv4_address.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'forwardable'
 require 'ipaddr'
 
@@ -59,9 +57,7 @@ module Pio
     # @return [Array]
     #    an array of decimal numbers converted from IPv4 address.
     def to_a
-      to_s.split('.').map do | each |
-        each.to_i
-      end
+      to_s.split('.').map(&:to_i)
     end
 
     # @return [Array]

data/lib/pio/lldp.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'English'
 require 'forwardable'
 require 'pio/lldp/frame'

data/lib/pio/lldp/chassis_id_tlv.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'bindata'
 
 module Pio

data/lib/pio/lldp/end_of_lldpdu_value.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'bindata'
 
 module Pio

data/lib/pio/lldp/frame.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'bindata'
 
 require 'pio/lldp/chassis_id_tlv'

data/lib/pio/lldp/management_address_value.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'bindata'
 
 module Pio

data/lib/pio/lldp/optional_tlv.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'pio/lldp/port_description_value'
 require 'pio/lldp/system_name_value'
 require 'pio/lldp/system_description_value'

data/lib/pio/lldp/options.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'pio/options'
 
 module Pio

data/lib/pio/lldp/organizationally_specific_value.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'bindata'
 
 module Pio

data/lib/pio/lldp/port_description_value.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'bindata'
 
 module Pio

data/lib/pio/lldp/port_id_tlv.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'bindata'
 
 module Pio

data/lib/pio/lldp/system_capabilities_value.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'bindata'
 
 module Pio

data/lib/pio/lldp/system_description_value.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'bindata'
 
 module Pio

data/lib/pio/lldp/system_name_value.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'bindata'
 
 module Pio

data/lib/pio/lldp/ttl_tlv.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'bindata'
 
 module Pio

data/lib/pio/mac.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'forwardable'
 
 module Pio
@@ -90,9 +88,7 @@ module Pio
     # @return [Array]
     #
     def to_a
-      to_s.split(':').map do | each |
-        each.hex
-      end
+      to_s.split(':').map(&:hex)
     end
 
     # @!endgroup
@@ -131,7 +127,7 @@ module Pio
     #   Mac.new("11:22:33:44:55:66").reserved? #=> false
     #
     def reserved?
-      ( to_i >> 8) == 0x0180c20000
+      (to_i >> 8) == 0x0180c20000
     end
 
     # @!endgroup

data/lib/pio/message_type_selector.rb

@@ -1,6 +1,5 @@
-# encoding: utf-8
-
 require 'English'
+require 'pio/parse_error'
 
 module Pio
   # Macros for defining message types.
@@ -10,8 +9,10 @@ module Pio
     end
 
     def read(raw_data)
-      parsed = const_get(:Format).read(raw_data)
-      const_get(:MESSAGE_TYPE)[parsed.message_type].create_from parsed
+      format = const_get(:Format).read(raw_data)
+      message = const_get(:MESSAGE_TYPE)[format.message_type].allocate
+      message.instance_variable_set :@format, format
+      message
     rescue
       raise Pio::ParseError, $ERROR_INFO.message
     end

data/lib/pio/open_flow.rb

@@ -0,0 +1,5 @@
+require 'pio/open_flow/flags'
+require 'pio/open_flow/message'
+require 'pio/open_flow/open_flow_header'
+require 'pio/open_flow/phy_port'
+require 'pio/open_flow/type'

data/lib/pio/open_flow/flags.rb

@@ -0,0 +1,38 @@
+# bitmap functions.
+module Flags
+  def flags(name, flags)
+    def_field name
+    def_get name, flags
+    def_set name, flags
+  end
+
+  def def_field(name)
+    module_eval("uint32 :#{name}")
+  end
+
+  def def_get(name, flags)
+    str = %{
+      def get
+        list = #{flags.inspect}
+        list.each_with_object([]) do |(key, value), result|
+          result << key if #{name} & value != 0
+          result
+        end
+      end
+    }
+    module_eval str
+  end
+
+  def def_set(name, flags)
+    str = %{
+      def set(v)
+        list = #{flags.inspect}
+        v.each do |each|
+          fail "Invalid state flag: \#{v}" unless list.keys.include?(each)
+        end
+        self.#{name} = v.empty? ? 0 : v.map { |each| list[each] }.inject(:|)
+      end
+    }
+    module_eval str
+  end
+end

data/lib/pio/open_flow/message.rb

@@ -0,0 +1,20 @@
+require 'forwardable'
+
+module Pio
+  module OpenFlow
+    # Defines shortcuts to OpenFlow header fields.
+    class Message
+      extend Forwardable
+
+      def_delegators :@format, :open_flow_header
+      def_delegators :open_flow_header, :ofp_version
+      def_delegators :open_flow_header, :message_type
+      def_delegators :open_flow_header, :message_length
+      def_delegators :open_flow_header, :transaction_id
+      def_delegator :open_flow_header, :transaction_id, :xid
+      def_delegators :@format, :body
+      def_delegator :@format, :body, :user_data
+      def_delegator :@format, :to_binary_s, :to_binary
+    end
+  end
+end

data/lib/pio/open_flow/open_flow_header.rb

@@ -0,0 +1,18 @@
+require 'bindata'
+
+module Pio
+  module Type
+    # OpenFlow 1.0 format.
+    module OpenFlow
+      # OpenFlow 1.0 message header format.
+      class OpenFlowHeader < BinData::Record
+        endian :big
+
+        uint8 :ofp_version, value: 1
+        uint8 :message_type, initial_value: :message_type_value
+        uint16 :message_length, initial_value: -> { 8 + body.length }
+        uint32 :transaction_id, initial_value: 0
+      end
+    end
+  end
+end

data/lib/pio/open_flow/phy_port.rb

@@ -0,0 +1,74 @@
+require 'bindata'
+require 'pio/type/mac_address'
+
+module Pio
+  module Type
+    module OpenFlow
+      # enum ofp_port_config
+      class PortConfig < BinData::Primitive
+        extend Flags
+
+        endian :big
+
+        flags :config,
+              port_down: 1 << 0,
+              no_stp: 1 << 1,
+              no_recv: 1 << 2,
+              no_recv_stp: 1 << 3,
+              no_flood: 1 << 4,
+              no_fwd: 1 << 5,
+              no_packet_in: 1 << 6
+      end
+
+      # enum ofp_port_state
+      class PortState < BinData::Primitive
+        extend Flags
+
+        endian :big
+
+        flags :state,
+              link_down: 1 << 0,
+              stp_listen: 0 << 8,
+              stp_learn: 1 << 8,
+              stp_forward: 2 << 8,
+              stp_block: 3 << 8
+      end
+
+      # enum ofp_port_features
+      class PortFeature < BinData::Primitive
+        extend Flags
+
+        endian :big
+
+        flags :features,
+              port_10mb_hd: 1 << 0,
+              port_10mb_fd: 1 << 1,
+              port_100mb_hd: 1 << 2,
+              port_100mb_fd: 1 << 3,
+              port_1gb_hd: 1 << 4,
+              port_1gb_fd: 1 << 5,
+              port_10gb_fd: 1 << 6,
+              port_copper: 1 << 7,
+              port_fiber: 1 << 8,
+              port_autoneg: 1 << 9,
+              port_pause: 1 << 10,
+              port_pause_asym: 1 << 11
+      end
+
+      # Description of a physical port
+      class PhyPort < BinData::Record
+        endian :big
+
+        uint16 :port_no
+        mac_address :hardware_address
+        string :name, length: 16, trim_padding: true
+        port_config :config
+        port_state :state
+        port_feature :curr
+        port_feature :advertised
+        port_feature :supported
+        port_feature :peer
+      end
+    end
+  end
+end