pio 0.16.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 399c1ee151a9c001cf2f626ae5cb9f20554664f6
-  data.tar.gz: 5aa7d55d32839bb91f762b1a601c20a72b4da882
+  metadata.gz: adb4a96e523a5a2ee14a1ae1e467820a57d1ecda
+  data.tar.gz: 16e5ef5fbd1ca5db6d6842adae25c083df64b6b6
 SHA512:
-  metadata.gz: 0f990c0cf9aef24a57f1c04a67f8134e1b6972dca1e0573f6274c9adeebddf5768f38266ad60a7766707ff6560cc031696a6ee1b6187794ec3d56374f3b33c61
-  data.tar.gz: b82319079f8387ef3c52d457bb4f69aff2cb2a34e2b3dcc04e9546534cc5d1ec0f690d162c99ff2a78dada0de47e19815abd8da40274fa0259274d98bd0cef39
+  metadata.gz: 51b278154025ee26b185c8e986c1d3f22a4be577ee00fcb5020724223fdd7824b4f7b3785259a4de11beeb0ffeb2ca6d50e1f3f770faf88c6e0415901672ffdc
+  data.tar.gz: d751e889d588d75e1d909724711e7e12b47deb16273f56a28eeef72dabbbfdf1319393fce1acb85c06e8dd140134b442b31c112f2948a986b5a936d76ee58a29

data/CHANGELOG.md

@@ -3,6 +3,13 @@
 ## develop (unreleased)
 
 
+## 0.17.0 (3/6/2015)
+### Changes
+* Renamed `Pio::PacketIn#data` => `Pio::PacketIn#raw_data`.
+* Renamed `Pio::PacketOut#data` => `Pio::PacketOut#raw_data`.
+* Fix behavior of `IPv4Address#eql?` and `IPv4Address#hash`.
+
+
 ## 0.16.0 (3/2/2015)
 ### New features
 * [#129](https://github.com/trema/pio/pull/129): Add new class `Pio::Udp`.

data/README.md

@@ -233,23 +233,26 @@ generate an Features Request/Reply message like below:
 
     # The Features xid (transaction_id)
     # should be same as that of the request.
-    reply = Pio::Features::Reply.new(
-              xid: request.xid,
-              dpid: 0x123,
-              n_buffers: 0x100,
-              n_tables: 0xfe,
-              capabilities: [:flow_stats, :table_stats, :port_stats,
-                             :queue_stats, :arp_match_ip],
-              actions: [: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],
-              ports: [{ port_no: 1,
-                        hardware_address: '11:22:33:44:55:66',
-                        name: 'port123',
-                        config: [:port_down],
-                        state: [:link_down],
-                        curr: [:port_10gb_fd, :port_copper] }]
-            )
+    reply =
+      Pio::Features::Reply.new(xid: request.xid,
+                               dpid: 0x123,
+                               n_buffers: 0x100,
+                               n_tables: 0xfe,
+                               capabilities: [:flow_stats, :table_stats,
+                                              :port_stats, :queue_stats,
+                                              :arp_match_ip],
+                               actions: [: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],
+                               ports: [{ port_no: 1,
+                                         hardware_address: '11:22:33:44:55:66',
+                                         name: 'port123',
+                                         config: [:port_down],
+                                         state: [:link_down],
+                                         curr: [:port_10gb_fd, :port_copper] }])
     reply.to_binary  # => Features Reply message in binary format.
 
 ### Packet-In
@@ -278,13 +281,11 @@ like below:
       0x00, 0x00, 0x00, 0x00, 0x00
     ].pack('C*')
 
-    packet_in = Pio::PacketIn.new(
-                  transaction_id: 0,
-                  buffer_id: 0xffffff00,
-                  in_port: 1,
-                  reason: :no_match,
-                  data: data_dump
-                )
+    packet_in = Pio::PacketIn.new(transaction_id: 0,
+                                  buffer_id: 0xffffff00,
+                                  in_port: 1,
+                                  reason: :no_match,
+                                  raw_data: data_dump)
     packet_in.to_binary  # => Packet-In message in binary format.
 
 ### Packet-Out
@@ -319,7 +320,7 @@ like below:
                                     buffer_id: 0xffffffff,
                                     in_port: 0xffff,
                                     actions: Pio::SendOutPort.new(2),
-                                    data: data_dump)
+                                    raw_data: data_dump)
     packet_out.to_binary  # => Packet-Out message in binary format.
 
 ### Flow Mod

data/examples/features_new.rb

@@ -5,21 +5,24 @@ request.to_binary  # => Features Request message in binary format.
 
 # The Features xid (transaction_id)
 # should be same as that of the request.
-reply = Pio::Features::Reply.new(
-  xid: request.xid,
-  dpid: 0x123,
-  n_buffers: 0x100,
-  n_tables: 0xfe,
-  capabilities: [:flow_stats, :table_stats, :port_stats,
-                 :queue_stats, :arp_match_ip],
-  actions: [: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],
-  ports: [{ port_no: 1,
-            hardware_address: '11:22:33:44:55:66',
-            name: 'port123',
-            config: [:port_down],
-            state: [:link_down],
-            curr: [:port_10gb_fd, :port_copper] }]
-        )
+reply =
+  Pio::Features::Reply.new(xid: request.xid,
+                           dpid: 0x123,
+                           n_buffers: 0x100,
+                           n_tables: 0xfe,
+                           capabilities: [:flow_stats, :table_stats,
+                                          :port_stats, :queue_stats,
+                                          :arp_match_ip],
+                           actions: [: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],
+                           ports: [{ port_no: 1,
+                                     hardware_address: '11:22:33:44:55:66',
+                                     name: 'port123',
+                                     config: [:port_down],
+                                     state: [:link_down],
+                                     curr: [:port_10gb_fd, :port_copper] }])
 reply.to_binary  # => Features Reply message in binary format.

data/examples/packet_in_new.rb

@@ -9,11 +9,9 @@ data_dump = [
   0x00, 0x00, 0x00, 0x00, 0x00
 ].pack('C*')
 
-packet_in = Pio::PacketIn.new(
-  transaction_id: 0,
-  buffer_id: 0xffffff00,
-  in_port: 1,
-  reason: :no_match,
-  data: data_dump
-            )
+packet_in = Pio::PacketIn.new(transaction_id: 0,
+                              buffer_id: 0xffffff00,
+                              in_port: 1,
+                              reason: :no_match,
+                              raw_data: data_dump)
 packet_in.to_binary  # => Packet-In message in binary format.

data/examples/packet_out_new.rb

@@ -14,5 +14,5 @@ packet_out = Pio::PacketOut.new(transaction_id: 0x16,
                                 buffer_id: 0xffffffff,
                                 in_port: 0xffff,
                                 actions: Pio::SendOutPort.new(2),
-                                data: data_dump)
+                                raw_data: data_dump)
 packet_out.to_binary  # => Packet-Out message in binary format.

data/features/packet_in_read.feature

@@ -15,6 +15,6 @@ Feature: Pio::PacketIn.read
     | total_len       |                60 |
     | in_port         |                 1 |
     | reason          |          no_match |
-    | data.length     |                60 |
+    | raw_data.length |                60 |
     | source_mac      | ac:5d:10:31:37:79 |
     | destination_mac | ff:ff:ff:ff:ff:ff |

data/features/packet_out_read.feature

@@ -17,5 +17,4 @@ Feature: Pio::PacketOut.read
     | actions.first.class       | Pio::SendOutPort |
     | actions.first.port_number |                2 |
     | actions.first.max_len     |            65535 |
-    | data.length               |               64 |
-
+    | raw_data.length           |               64 |

data/lib/pio/arp/format.rb

@@ -11,7 +11,7 @@ module Pio
 
       endian :big
 
-      ethernet_header ether_type: 0x0806
+      ethernet_header ether_type: EtherType::ARP
       uint16 :hardware_type, value: 1
       uint16 :protocol_type, value: 0x0800
       uint8 :hardware_length, value: 6

data/lib/pio/dhcp/frame.rb

@@ -17,8 +17,8 @@ module Pio
       include UdpHeader
 
       endian :big
-      ethernet_header ether_type: EthernetHeader::ETHER_TYPE_IP
-      ipv4_header ip_protocol: IPv4Header::IP_PROTOCOL_UDP
+      ethernet_header ether_type: EtherType::IPV4
+      ipv4_header ip_protocol: ProtocolNumber::UDP
       udp_header
       dhcp_field :dhcp
       string :padding, read_length: 0, initial_value: :ff_and_padding

data/lib/pio/ethernet_header.rb

@@ -1,29 +1,28 @@
 require 'pio/type/mac_address'
 
-# Base module
 module Pio
   # Adds ethernet_header macro.
   module EthernetHeader
-    ETHER_TYPE_IP = 0x0800
+    # EtherType constants for ethernet_header.ether_type.
+    module EtherType
+      ARP = 0x0806
+      IPV4 = 0x0800
+      VLAN = 0x8100
+      LLDP = 0x88cc
+    end
 
-    # rubocop:disable AbcSize
+    # This method smells of :reek:TooManyStatements
     def self.included(klass)
-      def klass.ethernet_header(options = {})
+      def klass.ethernet_header(options)
         mac_address :destination_mac
         mac_address :source_mac
-        uint16 :ether_type_internal, initial_value: options[:ether_type] || 0
-        bit3 :vlan_pcp_internal, onlyif: -> { vlan? }
-        bit1 :vlan_cfi, onlyif: -> { vlan? }
-        bit12 :vlan_vid_internal, onlyif: -> { vlan? }
-        uint16 :ether_type_vlan,
-               onlyif: -> { vlan? }, initial_value: options[:ether_type] || 0
+        uint16 :ether_type, value: options.fetch(:ether_type)
+        bit3 :vlan_pcp_internal, onlyif: :vlan?
+        bit1 :vlan_cfi, onlyif: :vlan?
+        bit12 :vlan_vid_internal, onlyif: :vlan?
+        uint16 :ether_type_vlan, value: :ether_type, onlyif: :vlan?
       end
     end
-    # rubocop:enable AbcSize
-
-    def ether_type
-      ether_type_internal
-    end
 
     def vlan_vid
       vlan? ? vlan_vid_internal : 0xffff
@@ -34,7 +33,7 @@ module Pio
     end
 
     def vlan?
-      ether_type == 0x8100
+      ether_type == EtherType::VLAN
     end
   end
 end

data/lib/pio/exact_match.rb

@@ -6,7 +6,7 @@ module Pio
     # rubocop:disable MethodLength
     # rubocop:disable AbcSize
     def initialize(packet_in)
-      data = packet_in.parsed_data
+      data = packet_in.data
       case data
       when PacketIn::DataParser::IPv4Packet
         options = {

data/lib/pio/features.rb

@@ -7,6 +7,7 @@ module Pio
     class Request; end
     OpenFlow::Message.factory(Request, OpenFlow::FEATURES_REQUEST)
 
+    # OpenFlow 1.0 Features Reply message.
     class Reply
       # Message body of features reply.
       class Body < BinData::Record

data/lib/pio/icmp/format.rb

@@ -13,8 +13,8 @@ module Pio
 
       endian :big
 
-      ethernet_header ether_type: EthernetHeader::ETHER_TYPE_IP
-      ipv4_header ip_protocol: IPv4Header::IP_PROTOCOL_ICMP
+      ethernet_header ether_type: EtherType::IPV4
+      ipv4_header ip_protocol: ProtocolNumber::ICMP
       uint8 :icmp_type
       uint8 :icmp_code, initial_value: 0
       uint16 :icmp_checksum, value: :calculate_icmp_checksum

data/lib/pio/ipv4_address.rb

@@ -42,6 +42,14 @@ module Pio
 
     def_delegator :value, :==
 
+    def eql?(other)
+      @value == other.value
+    end
+
+    def hash
+      to_s.hash
+    end
+
     # @return [Number] prefix length of IPv4 address.
     def prefixlen
       netmask = to_range.first.to_i ^ to_range.last.to_i

data/lib/pio/ipv4_header.rb

@@ -4,10 +4,13 @@ require 'pio/type/ip_address'
 module Pio
   # IP Version 4 Header Format
   module IPv4Header
-    include Payload
+    # Internet protocol numbers for ipv4_header.ip_protocol
+    module ProtocolNumber
+      ICMP = 1
+      UDP = 17
+    end
 
-    IP_PROTOCOL_ICMP = 1
-    IP_PROTOCOL_UDP = 17
+    include Payload
 
     # rubocop:disable MethodLength
     # rubocop:disable AbcSize

data/lib/pio/lldp/frame.rb

@@ -14,7 +14,7 @@ module Pio
 
       endian :big
 
-      ethernet_header ether_type: 0x88cc
+      ethernet_header ether_type: EtherType::LLDP
       chassis_id_tlv :chassis_id
       port_id_tlv :port_id
       ttl_tlv :ttl, initial_value: 120

data/lib/pio/packet_in.rb

@@ -29,32 +29,31 @@ module Pio
       endian :big
 
       uint32 :buffer_id
-      uint16 :total_len, value: -> { data.length }
+      uint16 :total_len, value: -> { raw_data.length }
       uint16 :in_port
       reason :reason
       uint8 :padding
       hide :padding
-      string :data, read_length: :total_len
+      string :raw_data, read_length: :total_len
 
       def empty?
         false
       end
 
       def length
-        10 + data.length
+        10 + raw_data.length
       end
     end
 
-    # Pio::PacketIn#data parser
+    # Pio::PacketIn#raw_data parser
     class DataParser
       # Ethernet header parser
-      class EthernetHeaderParser < BinData::Record
-        include EthernetHeader
-
+      class EtherTypeParser < BinData::Record
         endian :big
 
-        ethernet_header
-        rest :payload
+        mac_address :destination_mac
+        mac_address :source_mac
+        uint16 :ether_type
       end
 
       # IPv4 packet parser
@@ -64,7 +63,7 @@ module Pio
 
         endian :big
 
-        ethernet_header
+        ethernet_header ether_type: EtherType::IPV4
         ipv4_header
 
         uint16 :transport_source_port
@@ -74,13 +73,13 @@ module Pio
 
       # rubocop:disable MethodLength
       def self.read(raw_data)
-        ethernet_header = EthernetHeaderParser.read(raw_data)
+        ethernet_header = EtherTypeParser.read(raw_data)
         case ethernet_header.ether_type
-        when 0x0800
+        when EthernetHeader::EtherType::IPV4
           IPv4Packet.read raw_data
-        when 0x0806
+        when EthernetHeader::EtherType::ARP
           Pio::Arp.read raw_data
-        when 0x88cc
+        when EthernetHeader::EtherType::LLDP
           Pio::Lldp.read raw_data
         else
           fail 'Failed to parse packet_in data.'
@@ -95,26 +94,22 @@ module Pio
     def_delegators :body, :total_len
     def_delegators :body, :in_port
     def_delegators :body, :reason
-    def_delegators :body, :data
+    def_delegators :body, :raw_data
 
     attr_accessor :datapath_id
     alias_method :dpid, :datapath_id
     alias_method :dpid=, :datapath_id=
 
-    def parsed_data
-      @parsed_data ||= PacketIn::DataParser.read(data)
+    def data
+      @data ||= PacketIn::DataParser.read(raw_data)
     end
 
     def lldp?
-      parsed_data.is_a? Lldp
-    end
-
-    def source_mac
-      parsed_data.source_mac
+      data.is_a? Lldp
     end
 
-    def destination_mac
-      parsed_data.destination_mac
+    def method_missing(method, *args)
+      data.__send__ method, *args
     end
   end
 end

data/lib/pio/packet_out.rb

@@ -13,14 +13,14 @@ module Pio
       uint16 :in_port
       uint16 :actions_len, initial_value: -> { actions.binary.length }
       actions :actions, length: -> { actions_len }
-      rest :data
+      rest :raw_data
 
       def empty?
         false
       end
 
       def length
-        8 + actions_len + data.length
+        8 + actions_len + raw_data.length
       end
     end
   end
@@ -30,6 +30,6 @@ module Pio
     def_delegators :body, :in_port
     def_delegators :body, :actions_len
     def_delegators :body, :actions
-    def_delegators :body, :data
+    def_delegators :body, :raw_data
   end
 end