trema 0.4.3 → 0.4.4

data/.travis.yml

@@ -4,6 +4,8 @@ script: "rake travis"
 
 rvm:
   - 1.8.7
+  - 1.9.3
+  - 2.0.0
 
 branches:
   only:

data/CONTRIBUTING.md

@@ -0,0 +1,12 @@
+# Contributing to Trema
+
+* Check out the latest develop to make sure the feature hasn't been
+  implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't
+  requested it and/or contributed it.
+* Fork the project.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it
+  in a future version unintentionally.
+* Squash your commits.
+* Create a pull-request.

data/Gemfile

@@ -16,14 +16,16 @@ group :development do
   gem "aruba", "~> 0.5.3"
   gem "cucumber", "~> 1.3.8"
   gem "flay", "~> 2.4.0"
-  gem "flog", "~> 4.1.2"
+  gem "flog", "~> 4.2.0"
   gem "rcov", "~> 1.0.0" if RUBY_VERSION < "1.9.0"
   gem "redcarpet", "~> 2.3.0" if RUBY_VERSION < "1.9.0"
   gem "redcarpet", "~> 3.0.0" if RUBY_VERSION >= "1.9.0"
-  gem "reek", "~> 1.3.3"
+  gem "reek", "~> 1.3.4"
   gem "relish", "~> 0.7"
   gem "rspec", "~> 2.14.1"
-  gem "yard", "~> 0.8.7.1"
+  gem "yard", "~> 0.8.7.2"
+  gem 'mime-types', '~> 1.25' if RUBY_VERSION < '1.9.0'
+  gem 'mime-types', '~> 2.0' if RUBY_VERSION >= '1.9.0'
 end
 
 

data/README.md

@@ -49,15 +49,15 @@ Getting Started
 1.Install the prerequisites at the command prompt:
 
     (In Ubuntu or Debian GNU/Linux)
-    $ sudo apt-get install gcc make ruby rubygems ruby-dev libpcap-dev libsqlite3-dev libglib2.0-dev
+    $ sudo apt-get install gcc make git ruby rubygems ruby-dev libpcap-dev libsqlite3-dev libglib2.0-dev
 
     (In Ubuntu 10.04)
-    $ sudo apt-get install gcc make ruby rubygems ruby-dev libopenssl-ruby libpcap-dev libsqlite3-dev libglib2.0-dev
+    $ sudo apt-get install gcc make git ruby rubygems ruby-dev libopenssl-ruby libpcap-dev libsqlite3-dev libglib2.0-dev
     $ sudo gem install rubygems-update
     $ sudo /var/lib/gems/1.8/bin/update_rubygems
 
     (In Fedora 16-19)
-    $ sudo yum install gcc make ruby rubygems ruby-devel libpcap-devel libsqlite3x-devel glib2-devel
+    $ sudo yum install gcc make git ruby rubygems ruby-devel libpcap-devel libsqlite3x-devel glib2-devel
 
 2.Install Trema at the command prompt:
 

data/Rakefile

@@ -105,7 +105,7 @@ end
 
 desc "Build Trema Ruby library."
 task "rubylib" => "libtrema:static"
-PaperHouse::RubyLibraryTask.new "rubylib" do | task |
+PaperHouse::RubyExtensionTask.new "rubylib" do | task |
   task.library_name = "trema"
   task.target_directory = Trema.ruby
   task.sources = "#{ Trema.ruby }/trema/*.c"
@@ -191,8 +191,8 @@ file Trema.openflow_h => Trema.objects do
 end
 directory Trema.objects
 
-CLOBBER.include File.join( Trema.objects, "openflow" )
-CLOBBER.include File.join( Trema.vendor_openflow )
+CLOBBER.include( Trema.vendor_openflow ) if FileTest.exists?( Trema.vendor_openflow )
+CLOBBER.include( File.join( Trema.objects, "openflow" ) ) if FileTest.exists?( File.join( Trema.objects, "openflow" ) )
 
 
 ################################################################################
@@ -205,6 +205,24 @@ def phost_src
   File.join Trema.vendor_phost, "src"
 end
 
+def phost_objects
+  FileList[ File.join( phost_src, "*.o" ) ]
+end
+
+def phost_vendor_binary
+  File.join phost_src, "phost"
+end
+
+def phost_cli_vendor_binary
+  File.join phost_src, "cli"
+end
+
+def phost_clean_targets
+  ( phost_objects + [ phost_vendor_binary, phost_cli_vendor_binary ] ).select do | each |
+    FileTest.exists? each
+  end
+end
+
 file Trema::Executables.phost do
   cd phost_src do
     sh "make"
@@ -221,10 +239,8 @@ file Trema::Executables.cli do
   install File.join( phost_src, "cli" ), Trema::Executables.cli, :mode => 0755
 end
 
-CLEAN.include FileList[ File.join( phost_src, "*.o" ) ]
-CLEAN.include File.join( phost_src, "phost" )
-CLEAN.include File.join( phost_src, "cli" )
-CLOBBER.include Trema.phost
+CLEAN.include phost_clean_targets
+CLOBBER.include( Trema.phost ) if FileTest.exists?( Trema.phost )
 
 
 ################################################################################
@@ -253,8 +269,8 @@ file Trema::Executables.ovs_openflowd do
   end
 end
 
-CLEAN.include Trema.vendor_openvswitch
-CLOBBER.include Trema.openvswitch
+CLEAN.include( Trema.vendor_openvswitch ) if FileTest.exists?( Trema.vendor_openvswitch )
+CLOBBER.include( Trema.openvswitch ) if FileTest.exists?( Trema.openvswitch )
 
 
 ################################################################################
@@ -298,8 +314,8 @@ file cbench_command => Trema.openflow_h do
   end
 end
 
-CLEAN.include Trema.oflops
-CLOBBER.include Trema.vendor_oflops
+CLEAN.include( Trema.oflops ) if FileTest.exists?( Trema.oflops )
+CLOBBER.include( Trema.vendor_oflops ) if FileTest.exists?( Trema.vendor_oflops )
 
 
 ################################################################################
@@ -315,8 +331,8 @@ file Trema.libcmockery_a do
   end
 end
 
-CLEAN.include Trema.vendor_cmockery
-CLOBBER.include Trema.cmockery
+CLEAN.include( Trema.vendor_cmockery ) if FileTest.exists?( Trema.vendor_cmockery )
+CLOBBER.include( Trema.cmockery ) if FileTest.exists?( Trema.cmockery )
 
 
 ################################################################################
@@ -736,7 +752,7 @@ directory $wireshark_plugins_dir
 
 task :openflow_wireshark_plugin => $wireshark_plugin
 
-CLEAN.include Trema.vendor_openflow_git
+CLEAN.include( Trema.vendor_openflow_git ) if FileTest.exists?( Trema.vendor_openflow_git )
 
 
 ################################################################################

data/bin/trema

@@ -60,6 +60,9 @@ class BinTrema
       c.desc "Specifies emulated network configuration"
       c.flag [ :c, :conf ]
 
+      c.desc "Disables initial flow cleanup for a connected switch"
+      c.switch [ :r, :no_flow_cleanup ], :negatable => false
+
       c.action do | global_options, options, args |
         trema_run options
       end

data/cruise.rb

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

data/features/examples/switch_monitor.feature

@@ -17,7 +17,7 @@ Feature: "Switch Monitor" sample application
     Given I 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 kill 0x3`
-     And *** sleep 1 ***
+     And *** sleep 2 ***
     Then the file "../../tmp/log/switch_monitor.log" should contain "Switch 0x3 is DOWN"
     When I run `trema up 0x3`
      And *** sleep 10 ***
@@ -28,7 +28,7 @@ Feature: "Switch Monitor" sample application
     Given I run `trema run ../../src/examples/switch_monitor/switch-monitor.rb -c switch_monitor.conf -d`
      And wait until "SwitchMonitor" is up
     When I run `trema kill 0x3`
-     And *** sleep 1 ***
+     And *** sleep 2 ***
     Then the file "../../tmp/log/SwitchMonitor.log" should contain "Switch 0x3 is DOWN"
     When I run `trema up 0x3`
      And *** sleep 10 ***

data/features/switch_event/add_forward_entry.feature

@@ -1,4 +1,3 @@
-@wip
 Feature: Ruby methods for adding switch event forwarding entry
   
   There are three Ruby methods provided for adding switch event forwarding entries:

data/features/switch_event/delete_forward_entry.feature

@@ -1,4 +1,3 @@
-@wip
 Feature: Ruby methods for deleting switch event forwarding entry
   
   There are three Ruby methods provided for deleting switch event forwarding entries.

data/features/switch_event/dump_forward_entries.feature

@@ -1,4 +1,3 @@
-@wip
 Feature: Ruby methods for dumping switch event forwarding entry
   
   There are two Ruby methods provided for dumping switch event forwarding entry.

data/features/switch_event/set_forward_entries.feature

@@ -1,4 +1,3 @@
-@wip
 Feature: Ruby methods for setting switch event forwarding entry
   
   There are two Ruby methods provided for setting switch event forwarding entry.

data/ruby/trema/command/run.rb

@@ -34,6 +34,9 @@ module Trema
       if options[ :tremashark ]
         $use_tremashark = true
       end
+      if options[ :no_flow_cleanup ]
+        $no_flow_cleanup = true
+      end
 
       need_cleanup = ( not running? )
 

data/ruby/trema/dsl/runner.rb

@@ -73,6 +73,7 @@ module Trema
             end
             SwitchManager.new( rule, @context.port )
           end
+        switch_manager.no_flow_cleanup = true if $no_flow_cleanup
         switch_manager.run!
       end
 

data/ruby/trema/mac.rb

@@ -16,154 +16,12 @@
 #
 
 
-require "forwardable"
+require "rubygems"
+require "pio"
 
 
 module Trema
-  #
-  # Ethernet address class
-  #
-  class Mac
-    extend Forwardable
-    def_delegator :@value, :hash
-
-
-    #
-    # Returns an Ethernet address in its numeric presentation.
-    #
-    # @example
-    #   Mac.new("11:22:33:44:55:66") #=> 18838586676582
-    #
-    # @return [Number] the Ethernet address in numeric format
-    #
-    attr_reader :value
-
-
-    #
-    # Creates a {Mac} instance that encapsulates Ethernet addresses.
-    #
-    # @overload initialize(value)
-    #
-    # @param [String,Integer] value
-    #   the Ethernet address to set to.
-    #
-    # @example address as a hexadecimal string
-    #   Mac.new("11:22:33:44:55:66")
-    #
-    # @example address as a hexadecimal number
-    #   Mac.new(0xffffffffffff)
-    #
-    # @raise [ArgumentError] if invalid format is detected.
-    # @raise [TypeError] if supplied argument is not a String or Integer.
-    #
-    def initialize value
-      case value
-        when String
-          @value = create_from( value )
-        when Integer
-          @value = value
-          validate_value_range
-        when Mac
-          @value = create_from( value.to_s )
-        else
-          raise TypeError, "Invalid MAC address: #{ value.inspect }"
-      end
-      @string = string_format
-    end
-
-
-    #
-    # Returns the Ethernet address as 6 pairs of hexadecimal digits
-    # delimited by colons.
-    #
-    # @example
-    #   Mac.new(18838586676582).to_s #=> "11:22:33:44:55:66"
-    #
-    # @return [String] the Ethernet address in String format
-    #
-    def to_s
-      @string
-    end
-
-
-    #
-    # Returns an array of decimal numbers converted from Ethernet's
-    # address string format.
-    #
-    # @example
-    #   Mac.new("11:22:33:44:55:66").to_a #=> [ 0x11, 0x22, 0x33, 0x44, 0x55, 0x66 ]
-    #
-    # @return [Array] the Ethernet address in Array format
-    #
-    def to_a
-      @string.split( ":" ).collect do | each |
-        each.hex
-      end
-    end
-
-
-    #
-    # @private
-    #
-    def == other
-      @value == other.value
-    end
-    alias :eql? :==
-
-
-    #
-    # Returns true if Ethernet address is a multicast address.
-    #
-    # @example
-    #   Mac.new("01:00:00:00:00:00").multicast? #=> true
-    #   Mac.new("00:00:00:00:00:00").multicast? #=> false
-    #
-    # @return [Boolean] whether the Ethernet address is multicast
-    #
-    def multicast?
-      to_a[ 0 ] & 1 == 1
-    end
-
-
-    #
-    # Returns true if Ethernet address is a broadcast address.
-    #
-    # @example
-    #   Mac.new("ff:ff:ff:ff:ff:ff").broadcast? #=> true
-    #
-    # @return [Boolean] whether the Ethernet address is broadcast
-    #
-    def broadcast?
-      to_a.all? { | each | each == 0xff }
-    end
-
-
-    ################################################################################
-    private
-    ################################################################################
-
-
-    def create_from string
-      octet_regex = "[0-9a-fA-F][0-9a-fA-F]"
-      if /^(#{ octet_regex }:){5}(#{ octet_regex })$/=~ string
-        string.gsub( ":", "" ).hex
-      else
-        raise ArgumentError, %{Invalid MAC address: "#{ string }"}
-      end
-    end
-
-
-    def validate_value_range
-      unless ( @value >= 0 and @value <= 0xffffffffffff )
-        raise ArgumentError, "Invalid MAC address: #{ @value }"
-      end
-    end
-
-
-    def string_format
-      sprintf( "%012x", @value ).unpack( "a2" * 6 ).join( ":" )
-    end
-  end
+  Mac = Pio::Mac
 end
 
 
@@ -172,3 +30,4 @@ end
 ### coding: utf-8-unix
 ### indent-tabs-mode: nil
 ### End:
+

data/ruby/trema/match.c

@@ -238,7 +238,7 @@ match_dl( VALUE self, uint8_t which ) {
   else {
     dl_addr = match->dl_dst;
   }
-  return rb_funcall( rb_eval_string( "Trema::Mac" ), rb_intern( "new" ), 1, ULL2NUM( mac_to_uint64( dl_addr ) ) );
+  return rb_funcall( rb_eval_string( "Pio::Mac" ), rb_intern( "new" ), 1, ULL2NUM( mac_to_uint64( dl_addr ) ) );
 }
 
 
@@ -395,16 +395,16 @@ match_tp_dst( VALUE self ) {
  *   @option options [Number] :in_port
  *     the physical port number to match.
  *
- *   @option options [String,Number,Trema::Mac] :dl_src
+ *   @option options [String,Number,Mac] :dl_src
  *     the source ethernet address to match specified either as 6
  *     pairs of hexadecimal digits delimited by colon or as a
- *     hexadecimal number or as a Trema::Mac object.
+ *     hexadecimal number or as a Mac object.
  *     (eg. "00:11:22:33:44:55" or 0x001122334455 or Mac.new("00:11:22:33:44:55")).
  *
  *   @option options [String,Number] :dl_dst
  *     the destination ethernet address to match specified either as a
  *     6 pairs of hexadecimal digits delimited by colon or as a
- *     hexadecimal number or as a Trema::Mac object.
+ *     hexadecimal number or as a Mac object.
  *     (eg. "00:11:22:33:44:55" or 0x001122334455 or Mac.new("00:11:22:33:44:55")).
  *
  *   @option options [Number] :dl_type
@@ -472,11 +472,11 @@ match_init( int argc, VALUE *argv, VALUE self ) {
       VALUE dl_src = rb_hash_aref( options, ID2SYM( rb_intern( "dl_src" ) ) );
       if ( dl_src != Qnil ) {
         VALUE dl_addr;
-        if ( rb_obj_is_kind_of( dl_src, rb_eval_string( "Trema::Mac" ) ) ) {
+        if ( rb_obj_is_kind_of( dl_src, rb_eval_string( "Pio::Mac" ) ) ) {
           dl_addr = dl_src;
         }
         else {
-          dl_addr = rb_funcall( rb_eval_string( "Trema::Mac" ), rb_intern( "new" ), 1, dl_src );
+          dl_addr = rb_funcall( rb_eval_string( "Pio::Mac" ), rb_intern( "new" ), 1, dl_src );
         }
         dl_addr_to_a( dl_addr, match->dl_src );
         match->wildcards &= ( uint32_t ) ~OFPFW_DL_SRC;
@@ -485,11 +485,11 @@ match_init( int argc, VALUE *argv, VALUE self ) {
       VALUE dl_dst = rb_hash_aref( options, ID2SYM( rb_intern( "dl_dst" ) ) );
       if ( dl_dst != Qnil ) {
         VALUE dl_addr;
-        if ( rb_obj_is_kind_of( dl_dst, rb_eval_string( "Trema::Mac" ) ) ) {
+        if ( rb_obj_is_kind_of( dl_dst, rb_eval_string( "Pio::Mac" ) ) ) {
           dl_addr = dl_dst;
         }
         else {
-          dl_addr = rb_funcall( rb_eval_string( "Trema::Mac" ), rb_intern( "new" ), 1, dl_dst );
+          dl_addr = rb_funcall( rb_eval_string( "Pio::Mac" ), rb_intern( "new" ), 1, dl_dst );
         }
         dl_addr_to_a( dl_addr, match->dl_dst );
         match->wildcards &= ( uint32_t ) ~OFPFW_DL_DST;