trema 0.4.5 → 0.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 56656657a56ff4e4bf6cfa8b906dfa401d954220
-  data.tar.gz: 3cedbb6a843395235cef1387b947251913c814dc
+  metadata.gz: b5d236d112d0ec7ea07f28665ac7def9a03ad148
+  data.tar.gz: 05ee642924ce569f3c2cd3aa565a5534dae6ba30
 SHA512:
-  metadata.gz: 03bc85f708bf3192783fa3b77e3ba6c59ddb910ba1919fa78e850cc0de36ddd80ff39c5255ea5a468a698b4663c826dece4aa877650ef80c4bff2533192083b3
-  data.tar.gz: 5766922aab5e81eaa24ebc4fcf1e6798e094de4a48410a853b9ce3f14dcc81cf3ebd3dd25a55a2a2d868c23221c5b0c973a31369e033d1a05dcfbb4d0630bab3
+  metadata.gz: b3e0b32a3d66e9c29a2b0448525a377a480b0bc18c0509b5eab85c0f27ebb78c11e1886bdd31227fe0a421c9880d6abbb969f83635a8f1536be94b6ba3ac5a1f
+  data.tar.gz: d1ebcf9d3b41d159e30b2b778f0783500bff5d5fe41f4afa3eede21b111d134537d8ee5b7e5aa5d5f7ad6579046924ef379508407e18001bdaabad2cf7c7d1e0

data/Gemfile

@@ -4,11 +4,7 @@ source "https://rubygems.org"
 # Include dependencies from trema.gemspec. DRY!
 gemspec
 
-
 # Add dependencies required to use your gem here.
-# Example:
-#   gem "activesupport", ">= 2.3.5"
-
 
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
@@ -24,6 +20,10 @@ group :development do
   gem "relish", "~> 0.7"
   gem "rspec", "~> 2.14.1"
   gem "yard", "~> 0.8.7.2"
+  gem 'guard', '~> 1.8.3' if RUBY_VERSION < '1.9.0'
+  gem 'guard', '~> 2.2.2' if RUBY_VERSION >= '1.9.0'
+  gem 'guard-bundler', '~> 1.0.0' if RUBY_VERSION < '1.9.0'
+  gem 'guard-bundler', '~> 2.0.0' if RUBY_VERSION >= '1.9.0'
   gem 'mime-types', '~> 1.25' if RUBY_VERSION < '1.9.0'
   gem 'mime-types', '~> 2.0' if RUBY_VERSION >= '1.9.0'
 end

data/Guardfile

@@ -0,0 +1,8 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :bundler do
+  watch('Gemfile')
+  # Uncomment next line if your Gemfile contains the `gemspec' command.
+  watch(/^.+\.gemspec/)
+end

data/Rakefile

@@ -534,7 +534,7 @@ end
 
 
 def cbench_latency_mode_options
-  "--switches 1 --loops 10 --delay 1000"
+  "--port 6653 --switches 1 --loops 10 --delay 1000"
 end
 
 
@@ -784,6 +784,7 @@ def libtrema_unit_tests
     :byteorder_test => [ :log, :utility, :wrapper, :trema_wrapper ],
     :daemon_test => [ :log, :utility, :wrapper, :trema_wrapper ],
     :ether_test => [ :buffer, :log, :utility, :wrapper, :trema_wrapper ],
+    :external_callback_test => [],
     :messenger_test => [ :doubly_linked_list, :hash_table, :event_handler, :linked_list, :utility, :wrapper, :timer, :log, :trema_wrapper ],
     :openflow_application_interface_test => [ :buffer, :byteorder, :hash_table, :doubly_linked_list, :linked_list, :log, :openflow_message, :packet_info, :stat, :trema_wrapper, :utility, :wrapper ],
     :openflow_message_test => [ :buffer, :byteorder, :linked_list, :log, :packet_info, :utility, :wrapper, :trema_wrapper ],

data/bin/trema

@@ -28,6 +28,7 @@ require "gli"
 require "trema/command"
 require "trema/util"
 require "trema/version"
+require "trema/default_openflow_channel_port"
 
 
 class BinTrema
@@ -57,6 +58,9 @@ class BinTrema
       c.desc "Enables Trema wireshark plugin"
       c.switch [ :s, :tremashark ], :negatable => false
 
+      c.desc "Overrides the default openflow channel port #{Trema::DEFAULT_OPENFLOW_CHANNEL_PORT}"
+      c.flag [ :p, :port ]
+
       c.desc "Specifies emulated network configuration"
       c.flag [ :c, :conf ]
 

data/cruise.rb

@@ -24,7 +24,7 @@
 # threshold.
 #
 
-$coverage_threshold = 70.0
+$coverage_threshold = 70.1
 
 
 ################################################################################

data/features/core/switch_manager.feature

@@ -14,7 +14,7 @@ Feature: switch_manager help
 
         -s, --switch=PATH               the command path of switch
         -n, --name=SERVICE_NAME         service name
-        -p, --port=PORT                 server listen port (default 6633)
+        -p, --port=PORT                 server listen port (default 6653)
         -d, --daemonize                 run in the background
         -l, --logging_level=LEVEL       set logging level
         -g, --syslog                    output log messages to syslog
@@ -32,7 +32,7 @@ Feature: switch_manager help
 
         -s, --switch=PATH               the command path of switch
         -n, --name=SERVICE_NAME         service name
-        -p, --port=PORT                 server listen port (default 6633)
+        -p, --port=PORT                 server listen port (default 6653)
         -d, --daemonize                 run in the background
         -l, --logging_level=LEVEL       set logging level
         -g, --syslog                    output log messages to syslog

data/features/examples/message.vendor-action.feature

@@ -11,14 +11,14 @@ Feature: "Vendor Action" sample application
       """
 
   @slow_process
-  Scenario: Run "Packet In" C example
+  Scenario: Vendor Action message in C
   Given I run `trema run ../../objects/examples/openflow_message/vendor_action -c vendor_action.conf -d`
    And wait until "vendor_action" is up
    And *** sleep 2 ***
   Then the file "../../tmp/log/openflowd.vendor_action.log" should contain "actions=note:54.72.65.6d.61.00"
 
   @slow_process
-  Scenario: Run "Packet In" Ruby example
+  Scenario: Vendor Action message in Ruby
   Given I run `trema run ../../src/examples/openflow_message/vendor-action.rb -c vendor_action.conf -d`
    And wait until "VendorActionSampleController" is up
    And *** sleep 2 ***

data/features/examples/message.vendor-stats-request.feature

@@ -0,0 +1,20 @@
+Feature: "Vendor Stats Request" sample application
+
+  In order to learn how to send Vendor Stats Request
+  As a developer using Trema
+  I want to execute "Vendor Stats Request" sample application
+
+  Background:
+    Given a file named "vendor_stats.conf" with:
+      """
+      vswitch( "vendor_stats" ) { datapath_id "0xabc" }
+      """
+
+  @slow_process
+  Scenario: Vendor Stats Request message in Ruby
+  Given I run `trema run ../../src/examples/openflow_message/vendor-stats-request.rb -c vendor_stats.conf -d`
+   And wait until "VendorStatsRequestSample" is up
+   And *** sleep 2 ***
+  Then the file "../../tmp/log/openflowd.vendor_stats.log" should contain "received: NXST_FLOW reques"
+   And the file "../../tmp/log/VendorStatsRequestSample.log" should contain "[vendor_stats_reply]"
+   And the file "../../tmp/log/VendorStatsRequestSample.log" should contain "vendor_id: 0x00002320"

data/features/trema_commands/kill.feature

@@ -24,22 +24,26 @@ Feature: kill command
   @slow_process
   Scenario: kill a switch
     When I run `trema kill 0x1`
+     And *** sleep 1 ***
     Then the vswitch "0x1" is terminated
 
   @slow_process
   Scenario: kill a host
     When I run `trema kill host1`
+     And *** sleep 1 ***
     Then the vhost "host1" is terminated
 
   @slow_process
   Scenario: kill hosts
     When I run `trema kill host1 host2`
+     And *** sleep 1 ***
     Then the vhost "host1" is terminated
      And the vhost "host2" is terminated
 
   @slow_process
   Scenario: kill a controller
     When I run `trema kill SwitchMonitor`
+     And *** sleep 1 ***
     Then the controller "SwitchMonitor" is terminated
 
   Scenario: no argument

data/features/trema_commands/killall.feature

@@ -23,6 +23,7 @@ Feature: killall command
      And I successfully run `trema run ../../objects/examples/switch_monitor/switch_monitor -c switch_monitor.conf -d`
      And wait until "switch_monitor" is up
     When I run `trema killall`
+     And *** sleep 1 ***
     Then switch_manager is terminated
      And switch is terminated
      And phost is terminated

data/features/trema_commands/run.feature

@@ -23,13 +23,32 @@ Feature: run command
      And wait until "learning_switch" is up
     Then the output should contain:
      """
-     switch_manager --daemonize --port=6633 -- port_status::learning_switch packet_in::learning_switch state_notify::learning_switch vendor::learning_switch
+     switch_manager --daemonize --port=6653 -- port_status::learning_switch packet_in::learning_switch state_notify::learning_switch vendor::learning_switch
      """
      And the output should contain:
      """
      learning_switch --name learning_switch -d
      """
 
+  @slow_process
+  Scenario: The --port option can override the default openflow channel port
+    When I run `which trema`
+    When I run `trema -v run ../../objects/examples/learning_switch/learning_switch -c network.conf --port 6633 -d`
+     And wait until "learning_switch" is up
+    Then the output should contain:
+     """
+     switch_manager --daemonize --port=6633 -- port_status::learning_switch packet_in::learning_switch state_notify::learning_switch vendor::learning_switch
+     """
+
+  @slow_process
+  Scenario: The -p option can override the default openflow channel port
+    When I run `trema -v run ../../objects/examples/learning_switch/learning_switch -c network.conf -p 6633 -d`
+     And wait until "learning_switch" is up
+    Then the output should contain:
+     """
+     switch_manager --daemonize --port=6633 -- port_status::learning_switch packet_in::learning_switch state_notify::learning_switch vendor::learning_switch
+     """
+
   @slow_process
   Scenario: switch_manager is killed when trema session is closed
     When I run `trema -v run /bin/true -c network.conf`

data/ruby/trema/command/run.rb

@@ -16,6 +16,7 @@
 #
 
 
+require "trema/default_openflow_channel_port"
 require "trema/dsl"
 require "trema/util"
 
@@ -27,6 +28,7 @@ module Trema
 
     def trema_run options
       @config_file = options[ :conf ] || nil
+      @openflow_port = options[ :port ] || DEFAULT_OPENFLOW_CHANNEL_PORT
 
       if options[ :daemonize ]
         $run_as_daemon = true
@@ -71,6 +73,8 @@ module Trema
         config = Trema::DSL::Configuration.new
       end
 
+      config.port = @openflow_port
+
       if ARGV[ 0 ]
         controller_file = ARGV[ 0 ].split.first
         if ruby_controller?

data/ruby/trema/default_openflow_channel_port.rb

@@ -0,0 +1,26 @@
+#
+# Copyright (C) 2008-2013 NEC Corporation
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License, version 2, as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+#
+
+module Trema
+  DEFAULT_OPENFLOW_CHANNEL_PORT = 6653
+end
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8
+### indent-tabs-mode: nil
+### End:

data/ruby/trema/dsl/configuration.rb

@@ -16,6 +16,7 @@
 #
 
 
+require "trema/default_openflow_channel_port"
 require "trema/app"
 require "trema/host"
 require "trema/link"
@@ -97,7 +98,7 @@ module Trema
       # @return [Configuration]
       #
       def initialize
-        @port = 6633
+        @port = DEFAULT_OPENFLOW_CHANNEL_PORT
         @apps = Trema::App.clear
         @hosts = Trema::Host.clear
         @links = Trema::Link.clear

data/ruby/trema/open-vswitch.rb

@@ -16,6 +16,7 @@
 #
 
 
+require "trema/default_openflow_channel_port"
 require "trema/daemon"
 require "trema/executables"
 require "trema/hardware-switch"
@@ -31,9 +32,6 @@ module Trema
     include Trema::Daemon
 
 
-    DEFAULT_PORT = 6633
-
-
     log_file { | vswitch | "openflowd.#{ vswitch.name }.log" }
     command { | vswitch | vswitch.__send__ :command }
 
@@ -46,7 +44,7 @@ module Trema
     #
     # @return [OpenVswitch]
     #
-    def initialize stanza, port = DEFAULT_PORT
+    def initialize stanza, port = DEFAULT_OPENFLOW_CHANNEL_PORT
       super stanza
       @port = port
       @interfaces = []

data/ruby/trema/stats-reply.c

@@ -502,12 +502,21 @@ handle_stats_reply(
     case OFPST_VENDOR:
     {
       uint32_t *vendor_id;
-      VALUE options = rb_hash_new();
       VALUE vendor_stats_arr = rb_ary_new2( 1 );
+      VALUE options = rb_hash_new();
       VALUE vendor_stats_reply;
 
       vendor_id = ( uint32_t * ) body->data;
       rb_hash_aset( options, ID2SYM( rb_intern( "vendor_id" ) ), UINT2NUM( *vendor_id ) );
+      if ( body_length > sizeof( uint32_t ) ) {
+        unsigned long length = body_length - sizeof( uint32_t );
+        uint8_t *data = ( uint8_t * ) body->data + sizeof( uint32_t );
+        VALUE ary = rb_ary_new2( ( signed ) length );
+        for ( unsigned long i = 0; i < length; i++ ) {
+          rb_ary_push( ary, INT2FIX( data[ i ] ) );
+        }
+        rb_hash_aset( options, ID2SYM( rb_intern( "data" ) ), ary );
+      }
       vendor_stats_reply = rb_funcall( rb_eval_string( "Trema::VendorStatsReply" ), rb_intern( "new" ), 1, options );
       rb_ary_push( vendor_stats_arr, vendor_stats_reply );
 

data/ruby/trema/stats-request.c

@@ -17,6 +17,7 @@
 
 
 #include "trema.h"
+#include "trema-ruby-utils.h"
 #include "ruby.h"
 
 
@@ -262,6 +263,18 @@ stats_vendor_id( VALUE self ) {
 }
 
 
+/*
+ * Vendor specific data payload.
+ *
+ * @return [Array] an array of data payload bytes.
+ * @return [nil] vendor specific data not found.
+ */
+static VALUE
+stats_vendor_data( VALUE self ) {
+  return rb_iv_get( self, "@data" );
+}
+
+
 uint32_t
 get_stats_request_num2uint( VALUE self, const char *field ) {
   return ( uint32_t ) NUM2UINT( rb_iv_get( self, field ) );
@@ -575,7 +588,10 @@ queue_stats_request_init( int argc, VALUE *argv, VALUE self ) {
  *
  *   @example
  *     VendorStatsRequest.new
- *     VendorStatsRequest.new( :vendor_id => 123 )
+ *     VendorStatsRequest.new(
+ *       :vendor_id => 123,
+ *       :data => "deadbeef".unpack( "C*" )
+ *     )
  *
  *   @param [Hash] options
  *     the options to create a message with.
@@ -584,6 +600,9 @@ queue_stats_request_init( int argc, VALUE *argv, VALUE self ) {
  *     request statistics for a specific vendor_id, otherwise set vendor_id
  *     to a default value of 0x00004cff.
  *
+ *   @option options [Array] :data
+ *     a String that holds vendor's defined arbitrary length data.
+ *
  *   @return [VendorStatsRequest]
  *     an object that encapsulates the +OFPT_STATS_REQUEST(OFPST_VENDOR)+ OpenFlow
  *     message.
@@ -610,6 +629,19 @@ vendor_stats_request_init( int argc, VALUE *argv, VALUE self ) {
   uint32_t *vendor;
   vendor = ( uint32_t * ) stats_request->body;
   *vendor = htonl( get_stats_request_num2uint( self, "@vendor_id" ) );
+
+  VALUE ary = rb_hash_aref( options, ID2SYM( rb_intern( "data" ) ) );
+  message->length = offsetof( struct ofp_stats_request, body ) + sizeof( uint32_t );
+  if ( ary != Qnil ) {
+    rb_iv_set( self, "@data", ary );
+    Check_Type( ary, T_ARRAY );
+    uint16_t ary_len = ( uint16_t ) RARRAY_LEN( ary );
+    uint8_t *data = append_back_buffer( message, ary_len );
+    for ( int i = 0; i < ary_len; i++ ) {
+      data[ i ] = ( uint8_t ) FIX2INT( RARRAY_PTR( ary )[ i ] );
+    }
+  }
+  set_length( message, ( uint16_t ) message->length );
   return self;
 }
 
@@ -671,6 +703,7 @@ Init_stats_request() {
   rb_define_alloc_func( cVendorStatsRequest, vendor_stats_request_alloc );
   rb_define_method( cVendorStatsRequest, "initialize", vendor_stats_request_init, -1 );
   rb_define_method( cVendorStatsRequest, "vendor_id", stats_vendor_id, 0 );
+  rb_define_method( cVendorStatsRequest, "data", stats_vendor_data, 0 );
 }
 
 

data/ruby/trema/vendor-stats-reply.rb

@@ -21,7 +21,7 @@ require "trema/stats-helper"
 
 module Trema
   class VendorStatsReply < StatsHelper
-    FIELDS = %w(vendor_id)
+    FIELDS = %w(vendor_id data)
     FIELDS.each { |field| attr_reader field.intern }
 
 
@@ -34,7 +34,8 @@ module Trema
     #
     #   @example
     #     VendorStatsReply.new(
-    #       :vendor_id => 123
+    #       :vendor_id => 123,
+    #       :data => "deadbeef".unpack( "C*" )
     #     )
     #
     #   @param [Hash] options
@@ -43,6 +44,9 @@ module Trema
     #   @option options [Number] :vendor_id
     #     the specific vendor identifier.
     #
+    #   @option options [Array] :data
+    #     a String that holds vendor's defined arbitrary length data.
+    #
     #   @return [VendorStatsReply]
     #     an object that encapsulates the OFPST_STATS_REPLY(OFPST_VENDOR) OpenFlow message.
     #