pio 0.22.0 → 0.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 06006d882906e150385cbe2e7932eb0d741277ee
-  data.tar.gz: 8b4f1fefee8d39a6e1ce9d173ace7284d5535d9f
+  metadata.gz: 964cf85acbc8d40d637ae0ade92ba7902871f763
+  data.tar.gz: 8b2030596db8463f4e96c58130c7f95789d518d1
 SHA512:
-  metadata.gz: 0e70773ffec96c1647cccc8b2a93b262f9655e3c3294e1ca6ee911385279a2fdb293357402eb5abb7f25e462785499b775cb82424fa4bb32859f71a257273aaf
-  data.tar.gz: d3c9c2353d742e752924726a77f9f91ab24c1dfdfe5870b651409c1b990eb75723ace6a39289316032571407a4edaca75c8ecfe6bd38ce3cb6c5e6b1f8833af1
+  metadata.gz: 256528fa1737e893e938f12f332e5e5e485e86b11dfdea88fb103ff646d83ad1e0a3c6e0526c22edcef3c06c47a08494ad7fd1a0291d43ee45a24ccf2489f8e4
+  data.tar.gz: 0ef1cd6a8a24b77b854f21c79362418db441ccd953e0e664eb09d1a69d901bbbabca6e9580e35ed8c680dfcf8a5a4a209f3c02b71cdfa660e43880aea72a1909

data/CHANGELOG.md

@@ -3,6 +3,13 @@
 ## develop (unreleased)
 
 
+## 0.23.0 (6/29/2015)
+### New features
+* [#183](https://github.com/trema/pio/pull/183): Add new class `Pio::PacketIn` (OpenFlow1.3).
+* [#185](https://github.com/trema/pio/pull/185): Add new classes `Pio::Match::TunnelId` and `Pio::Match::MaskedTunnelId`
+* [#184](https://github.com/trema/pio/pull/184): Add new classes `Pio::Match::ArpOp`, `Pio::Match::ArpSenderProtocolAddress`, `Pio::Match::ArpTargetProtocolAddress`, `Pio::Match::ArpSenderHardwareAddress`, `Pio::Match::ArpTargetHardwareAddress`, `Pio::Match::MaskedArpSenderProtocolAddress`,`Pio::Match::MaskedArpTargetProtocolAddress`, `Pio::Match::MaskedArpSenderHardwareAddress` and `Pio::Match::MaskedArpTargetHardwareAddress`
+
+
 ## 0.22.0 (6/25/2015)
 ### New features
 * [#177](https://github.com/trema/pio/pull/177): Add new class `Pio::PacketIn` (OpenFlow1.3).

data/README.md

@@ -36,6 +36,7 @@ supports the following packet formats:
   - [Features Request](https://relishapp.com/trema/pio/docs/open-flow13/pio-features-request)
   - [Features Reply](https://relishapp.com/trema/pio/docs/open-flow13/pio-features-reply)
   - [Packet In](https://relishapp.com/trema/pio/docs/open-flow13/pio-packetin)
+  - [Packet Out](https://relishapp.com/trema/pio/docs/open-flow13/pio-packetout)
   - [Flow Mod](https://relishapp.com/trema/pio/docs/open-flow13/pio-flowmod)
 
 ## Features Overview

data/Rakefile

@@ -1,7 +1,7 @@
 require 'bundler/gem_tasks'
 
 RELISH_PROJECT = 'trema/pio'
-FLAY_THRESHOLD = 398
+FLAY_THRESHOLD = 452
 
 task default: :travis
 task test: [:spec, :cucumber]

data/features/open_flow13/match.feature

@@ -280,6 +280,109 @@ Feature: Pio::Match
       | ip_protocol |     1 |
       | icmpv4_code |     0 |
 
+  Scenario: new(eth_type: 2054, arp_op: 1)
+    When I try to create an OpenFlow message with:
+      """
+      Pio::Match.new(ether_type: 2054, arp_op: 1)
+      """
+    Then it should finish successfully
+    And the message have the following fields and values:
+      | field      | value |
+      | ether_type |  2054 |
+      | arp_op     |     1 |
+
+  Scenario: new(eth_type: 2054, arp_sender_protocol_address: '1.2.3.4')
+    When I try to create an OpenFlow message with:
+      """
+      Pio::Match.new(ether_type: 2054, arp_sender_protocol_address: '1.2.3.4')
+      """
+    Then it should finish successfully
+    And the message have the following fields and values:
+      | field                       |   value |
+      | ether_type                  |    2054 |
+      | arp_sender_protocol_address | 1.2.3.4 |
+
+  Scenario: new(eth_type: 2054, arp_sender_protocol_address: '1.2.3.4', arp_sender_protocol_address_mask: '255.255.0.0')
+    When I try to create an OpenFlow message with:
+      """
+      Pio::Match.new(ether_type: 2054, arp_sender_protocol_address: '1.2.3.4', arp_sender_protocol_address_mask: '255.255.0.0')
+      """
+    Then it should finish successfully
+    And the message have the following fields and values:
+      | field                            |       value |
+      | ether_type                       |        2054 |
+      | arp_sender_protocol_address      |     1.2.3.4 |
+      | arp_sender_protocol_address_mask | 255.255.0.0 |
+
+  Scenario: new(eth_type: 2054, arp_target_protocol_address: '1.2.3.4')
+    When I try to create an OpenFlow message with:
+      """
+      Pio::Match.new(ether_type: 2054, arp_target_protocol_address: '1.2.3.4')
+      """
+    Then it should finish successfully
+    And the message have the following fields and values:
+      | field                       |   value |
+      | ether_type                  |    2054 |
+      | arp_target_protocol_address | 1.2.3.4 |
+
+  Scenario: new(eth_type: 2054, arp_target_protocol_address: '1.2.3.4', arp_target_protocol_address_mask: '255.255.0.0')
+    When I try to create an OpenFlow message with:
+      """
+      Pio::Match.new(ether_type: 2054, arp_target_protocol_address: '1.2.3.4', arp_target_protocol_address_mask: '255.255.0.0')
+      """
+    Then it should finish successfully
+    And the message have the following fields and values:
+      | field                            |       value |
+      | ether_type                       |        2054 |
+      | arp_target_protocol_address      |     1.2.3.4 |
+      | arp_target_protocol_address_mask | 255.255.0.0 |
+
+  Scenario: new(eth_type: 2054, arp_sender_hardware_address: '11:22:33:44:55:66')
+    When I try to create an OpenFlow message with:
+      """
+      Pio::Match.new(ether_type: 2054, arp_sender_hardware_address: '11:22:33:44:55:66')
+      """
+    Then it should finish successfully
+    And the message have the following fields and values:
+      | field                       |             value |
+      | ether_type                  |              2054 |
+      | arp_sender_hardware_address | 11:22:33:44:55:66 |
+
+  Scenario: new(eth_type: 2054, arp_sender_hardware_address: '11:22:33:44:55:66', arp_sender_hardware_address_mask: 'ff:ff:ff:00:00:00')
+    When I try to create an OpenFlow message with:
+      """
+      Pio::Match.new(ether_type: 2054, arp_sender_hardware_address: '11:22:33:44:55:66', arp_sender_hardware_address_mask: 'ff:ff:ff:00:00:00')
+      """
+    Then it should finish successfully
+    And the message have the following fields and values:
+      | field                            |             value |
+      | ether_type                       |              2054 |
+      | arp_sender_hardware_address      | 11:22:33:44:55:66 |
+      | arp_sender_hardware_address_mask | ff:ff:ff:00:00:00 |
+
+  Scenario: new(eth_type: 2054, arp_target_hardware_address: '11:22:33:44:55:66')
+    When I try to create an OpenFlow message with:
+      """
+      Pio::Match.new(ether_type: 2054, arp_target_hardware_address: '11:22:33:44:55:66')
+      """
+    Then it should finish successfully
+    And the message have the following fields and values:
+      | field                       |             value |
+      | ether_type                  |              2054 |
+      | arp_target_hardware_address | 11:22:33:44:55:66 |
+
+  Scenario: new(eth_type: 2054, arp_target_hardware_address: '11:22:33:44:55:66', arp_target_hardware_address_mask: 'ff:ff:ff:00:00:00')
+    When I try to create an OpenFlow message with:
+      """
+      Pio::Match.new(ether_type: 2054, arp_target_hardware_address: '11:22:33:44:55:66', arp_target_hardware_address_mask: 'ff:ff:ff:00:00:00')
+      """
+    Then it should finish successfully
+    And the message have the following fields and values:
+      | field                            |             value |
+      | ether_type                       |              2054 |
+      | arp_target_hardware_address      | 11:22:33:44:55:66 |
+      | arp_target_hardware_address_mask | ff:ff:ff:00:00:00 |
+
   Scenario: new(ether_type: 0x86dd, ipv6_source_address: '2001:db8:bd05:1d2:288a:1fc0:1:10ee')
     When I try to create an OpenFlow message with:
       """
@@ -326,6 +429,27 @@ Feature: Pio::Match
       | ipv6_destination_address      | 2001:db8:bd05:1d2:288a:1fc0:1:10ee |
       | ipv6_destination_address_mask | ffff:ffff:ffff:ffff::              |
 
+  Scenario: new(tunnel_id: 1)
+    When I try to create an OpenFlow message with:
+      """
+      Pio::Match.new(tunnel_id: 1)
+      """
+    Then it should finish successfully
+    And the message have the following fields and values:
+      | field     | value |
+      | tunnel_id |     1 |
+
+  Scenario: new(tunnel_id: 1, tunnel_id_mask: 9223372036854775808)
+    When I try to create an OpenFlow message with:
+      """
+      Pio::Match.new(tunnel_id: 1, tunnel_id_mask: 9223372036854775808)
+      """
+    Then it should finish successfully
+    And the message have the following fields and values:
+      | field          |               value |
+      | tunnel_id      |                   1 |
+      | tunnel_id_mask | 9223372036854775808 |
+
   Scenario: read (file: open_flow13/oxm_no_fields.raw)
     When I try to parse a file named "open_flow13/oxm_no_fields.raw" with "Pio::Match" class
     Then it should finish successfully
@@ -529,6 +653,82 @@ Feature: Pio::Match
       | ip_protocol |     1 |
       | icmpv4_code |     0 |
 
+  Scenario: read (file: open_flow13/oxm_arp_op_field.raw)
+    When I try to parse a file named "open_flow13/oxm_arp_op_field.raw" with "Pio::Match" class
+    Then it should finish successfully
+    And the message have the following fields and values:
+      | field      | value |
+      | ether_type |  2054 |
+      | arp_op     |     1 |
+
+  Scenario: read (file: open_flow13/oxm_arp_spa_field.raw)
+    When I try to parse a file named "open_flow13/oxm_arp_spa_field.raw" with "Pio::Match" class
+    Then it should finish successfully
+    And the message have the following fields and values:
+      | field                       |   value |
+      | ether_type                  |    2054 |
+      | arp_sender_protocol_address | 1.2.3.4 |
+
+  Scenario: read (file: open_flow13/oxm_masked_arp_spa_field.raw)
+    When I try to parse a file named "open_flow13/oxm_masked_arp_spa_field.raw" with "Pio::Match" class
+    Then it should finish successfully
+    And the message have the following fields and values:
+      | field                            |       value |
+      | ether_type                       |        2054 |
+      | arp_sender_protocol_address      |     1.2.3.4 |
+      | arp_sender_protocol_address_mask | 255.255.0.0 |
+
+  Scenario: read (file: open_flow13/oxm_arp_tpa_field.raw)
+    When I try to parse a file named "open_flow13/oxm_arp_tpa_field.raw" with "Pio::Match" class
+    Then it should finish successfully
+    And the message have the following fields and values:
+      | field                       |   value |
+      | ether_type                  |    2054 |
+      | arp_target_protocol_address | 1.2.3.4 |
+
+  Scenario: read (file: open_flow13/oxm_masked_arp_tpa_field.raw)
+    When I try to parse a file named "open_flow13/oxm_masked_arp_tpa_field.raw" with "Pio::Match" class
+    Then it should finish successfully
+    And the message have the following fields and values:
+      | field                            |       value |
+      | ether_type                       |        2054 |
+      | arp_target_protocol_address      |     1.2.3.4 |
+      | arp_target_protocol_address_mask | 255.255.0.0 |
+
+  Scenario: read (file: open_flow13/oxm_arp_sha_field.raw)
+    When I try to parse a file named "open_flow13/oxm_arp_sha_field.raw" with "Pio::Match" class
+    Then it should finish successfully
+    And the message have the following fields and values:
+    | field                       |             value |
+    | ether_type                  |              2054 |
+    | arp_sender_hardware_address | 11:22:33:44:55:66 |
+
+  Scenario: read (file: open_flow13/oxm_masked_arp_sha_field.raw)
+    When I try to parse a file named "open_flow13/oxm_masked_arp_sha_field.raw" with "Pio::Match" class
+    Then it should finish successfully
+    And the message have the following fields and values:
+      | field                            |             value |
+      | ether_type                       |              2054 |
+      | arp_sender_hardware_address      | 11:22:33:44:55:66 |
+      | arp_sender_hardware_address_mask | ff:ff:ff:ff:ff:ff |
+
+  Scenario: read (file: open_flow13/oxm_arp_tha_field.raw)
+    When I try to parse a file named "open_flow13/oxm_arp_tha_field.raw" with "Pio::Match" class
+    Then it should finish successfully
+    And the message have the following fields and values:
+      | field                       |             value |
+      | ether_type                  |              2054 |
+      | arp_target_hardware_address | 11:22:33:44:55:66 |
+
+  Scenario: read (file: open_flow13/oxm_masked_arp_tha_field.raw)
+    When I try to parse a file named "open_flow13/oxm_masked_arp_tha_field.raw" with "Pio::Match" class
+    Then it should finish successfully
+    And the message have the following fields and values:
+      | field                            |             value |
+      | ether_type                       |              2054 |
+      | arp_target_hardware_address      | 11:22:33:44:55:66 |
+      | arp_target_hardware_address_mask | ff:ff:ff:ff:ff:ff |
+
   Scenario: read (file: open_flow13/oxm_ipv6_source_field.raw)
     When I try to parse a file named "open_flow13/oxm_ipv6_source_field.raw" with "Pio::Match" class
     Then it should finish successfully
@@ -562,3 +762,18 @@ Feature: Pio::Match
       | ether_type                    | 34525                              |
       | ipv6_destination_address      | 2001:db8:bd05:1d2:288a:1fc0:1:10ee |
       | ipv6_destination_address_mask | ffff:ffff:ffff:ffff::              |
+
+  Scenario: read (file: open_flow13/oxm_tunnel_id_field.raw)
+    When I try to parse a file named "open_flow13/oxm_tunnel_id_field.raw" with "Pio::Match" class
+    Then it should finish successfully
+    And the message have the following fields and values:
+      | field     | value |
+      | tunnel_id |     1 |
+
+  Scenario: read (file: open_flow13/oxm_masked_tunnel_id_field.raw)
+    When I try to parse a file named "open_flow13/oxm_masked_tunnel_id_field.raw" with "Pio::Match" class
+    Then it should finish successfully
+    And the message have the following fields and values:
+      | field          |               value |
+      | tunnel_id      |                   1 |
+      | tunnel_id_mask | 9223372036854775808 |

data/features/open_flow13/packet_out.feature

@@ -0,0 +1,96 @@
+Feature: Pio::PacketOut
+  Background:
+    Given I use OpenFlow 1.3
+
+  Scenario: new
+    When I try to create an OpenFlow message with:
+      """
+      Pio::PacketOut.new
+      """
+    Then it should finish successfully
+    And the message have the following fields and values:
+      | field           |          value |
+      | class           | Pio::PacketOut |
+      | ofp_version     |              4 |
+      | message_type    |             13 |
+      | message_length  |             24 |
+      | transaction_id  |              0 |
+      | xid             |              0 |
+      | buffer_id       |     :no_buffer |
+      | in_port         |              0 |
+      | actions_length  |              0 |
+      | raw_data.length |              0 |
+
+  Scenario: new (actions = SendOutPort(1), raw_data = ARP Request)
+    When I try to create an OpenFlow message with:
+      """
+      data_dump = [
+        0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xac, 0x5d, 0x10, 0x31, 0x37,
+        0x79, 0x08, 0x06, 0x00, 0x01, 0x08, 0x00, 0x06, 0x04, 0x00, 0x01,
+        0xac, 0x5d, 0x10, 0x31, 0x37, 0x79, 0xc0, 0xa8, 0x02, 0xfe, 0xff,
+        0xff, 0xff, 0xff, 0xff, 0xff, 0xc0, 0xa8, 0x02, 0x05, 0x00, 0x00,
+        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+        0x00, 0x00, 0x00, 0x00, 0x00
+      ].pack('C*')
+
+      Pio::PacketOut.new(raw_data: data_dump, actions: Pio::SendOutPort.new(1))
+      """
+    Then it should finish successfully
+    And the message have the following fields and values:
+      | field                   |             value |
+      | class                   |    Pio::PacketOut |
+      | ofp_version             |                 4 |
+      | message_type            |                13 |
+      | message_length          |               100 |
+      | transaction_id          |                 0 |
+      | xid                     |                 0 |
+      | buffer_id               |        :no_buffer |
+      | in_port                 |                 0 |
+      | actions_length          |                16 |
+      | raw_data.length         |                60 |
+      | data.class              | Pio::Arp::Request |
+      | destination_mac         | ff:ff:ff:ff:ff:ff |
+      | source_mac              | ac:5d:10:31:37:79 |
+      | ether_type              |              2054 |
+      | hardware_type           |                 1 |
+      | protocol_type           |              2048 |
+      | hardware_length         |                 6 |
+      | protocol_length         |                 4 |
+      | operation               |                 1 |
+      | sender_hardware_address | ac:5d:10:31:37:79 |
+      | sender_protocol_address |     192.168.2.254 |
+      | target_hardware_address | ff:ff:ff:ff:ff:ff |
+      | target_protocol_address |       192.168.2.5 |
+
+  Scenario: read
+    When I try to parse a file named "open_flow13/packet_out.raw" with "PacketOut" class
+    Then it should finish successfully
+    And the message have the following fields and values:
+      | field                    |             value |
+      | class                    |    Pio::PacketOut |
+      | ofp_version              |                 4 |
+      | message_type             |                13 |
+      | message_length           |               100 |
+      | transaction_id           |               123 |
+      | xid                      |               123 |
+      | buffer_id                |        :no_buffer |
+      | in_port                  |       :controller |
+      | actions_length           |                16 |
+      | actions.first.class      |  Pio::SendOutPort |
+      | actions.first.port       |                 1 |
+      | actions.first.max_length |        :no_buffer |
+      | raw_data.length          |                60 |
+      | data.class               | Pio::Arp::Request |
+      | destination_mac          | ff:ff:ff:ff:ff:ff |
+      | source_mac               | ac:5d:10:31:37:79 |
+      | ether_type               |              2054 |
+      | hardware_type            |                 1 |
+      | protocol_type            |              2048 |
+      | hardware_length          |                 6 |
+      | protocol_length          |                 4 |
+      | operation                |                 1 |
+      | sender_hardware_address  | ac:5d:10:31:37:79 |
+      | sender_protocol_address  |     192.168.2.254 |
+      | target_hardware_address  | ff:ff:ff:ff:ff:ff |
+      | target_protocol_address  |       192.168.2.5 |
+      

data/lib/pio/open_flow13.rb

@@ -16,6 +16,7 @@ require 'pio/open_flow13/hello'
 require 'pio/open_flow13/match'
 require 'pio/open_flow13/meter'
 require 'pio/open_flow13/packet_in'
+require 'pio/open_flow13/packet_out'
 require 'pio/open_flow13/send_out_port'
 require 'pio/open_flow13/write_metadata'
 

data/lib/pio/open_flow13/actions.rb

@@ -0,0 +1,42 @@
+require 'bindata'
+
+module Pio
+  # Actions not yet implemented.
+  class UnsupportedAction < BinData::Record
+    endian :big
+
+    uint16 :action_type
+    uint16 :action_length
+  end
+
+  # Actions list of actions-apply instruction.
+  class Actions < BinData::Primitive
+    mandatory_parameter :length
+
+    endian :big
+
+    string :binary, read_length: :length
+
+    def set(value)
+      self.binary = [value].flatten.map(&:to_binary).join
+    end
+
+    # rubocop:disable MethodLength
+    def get
+      actions = []
+      tmp = binary
+      while tmp.length > 0
+        action = case BinData::Uint16be.read(tmp)
+                 when 0
+                   SendOutPort.read(tmp)
+                 else
+                   UnsupportedAction.read(tmp)
+                 end
+        tmp = tmp[action.action_length..-1]
+        actions << action
+      end
+      actions
+    end
+    # rubocop:enable MethodLength
+  end
+end