trema 0.3.6 → 0.3.7

data/Rantfile

@@ -25,6 +25,7 @@ $LOAD_PATH.unshift File.expand_path( File.join File.dirname( __FILE__ ), "vendor
 require "trema/executables"
 require "trema/path"
 require "trema/dsl/parser"
+require "trema/version"
 
 import "c/dependencies"
 import "directedrule"
@@ -366,7 +367,7 @@ end
 
 
 ################################################################################
-# Build libtrema.a
+# Build libtrema.{a,so}
 ################################################################################
 
 build_libtrema_a = Proc.new do | t |
@@ -375,6 +376,11 @@ build_libtrema_a = Proc.new do | t |
   sys "ranlib #{ t.name }"
 end
 
+build_libtrema_so = Proc.new do | t |
+  soname = File.basename( t.name ).sub( /\.\d+\.\d+\Z/, "" )
+  sys "gcc -shared -Wl,-soname=#{ soname } -o #{ t.name } #{ sys.sp t.prerequisites }"
+end
+
 
 task dependency( "libtrema" ) => "vendor:openflow"
 gen C::Dependencies, dependency( "libtrema" ),
@@ -390,6 +396,7 @@ gen Directory, Trema.lib
 gen Directory, "#{ Trema.home }/objects/unittests"
 
 libtrema = File.join( Trema.lib, "libtrema.a" )
+libtrema_so = File.join( Trema.lib, "libtrema.so." ) + Trema::VERSION
 libtrema_gcov = File.join( "#{ Trema.home }/objects/unittests", "libtrema.a" )
 
 libtrema_o = gen DirectedRule, Trema.lib => [ Trema.include ], :o => :c do | t |
@@ -399,12 +406,18 @@ libtrema_gcov_o = gen DirectedRule, "#{ Trema.home }/objects/unittests" => [ Tre
   sys "gcc --coverage -I#{ objects "openflow" } #{ var :CFLAGS } -fPIC -c -o #{ t.name } #{ t.source }"
 end
 
-desc "Build trema library."
+desc "Build trema library (static library)."
 task :libtrema => libtrema
 file libtrema => libtrema_o.candidates do | t |
   build_libtrema_a.call t
 end
 
+desc "Build trema library (shared library)."
+task :libtrema_so => libtrema_so
+file libtrema_so => libtrema_o.candidates do | t |
+  build_libtrema_so.call t
+end
+
 desc "Build trema library (coverage)."
 task "coverage:libtrema" => libtrema_gcov
 file libtrema_gcov => libtrema_gcov_o.candidates do | t |

data/bin/trema

@@ -148,6 +148,23 @@ command :send_packets do | c |
 end
 
 
+desc "Brings a switch's specified port down"
+command :port_down do | c |
+  c.desc "switch name"
+  c.flag [ :s, :switch ]
+
+  c.desc "port"
+  c.flag [ :p, :port ]
+
+  c.action do | global_options, options, args |
+    raise "--switch option is mandatory" if options[ :switch ].nil?
+    raise "--port option is mandatory" if options[ :port ].nil?
+
+    trema_port_down options[ :switch ], options[ :port ]
+  end
+end
+
+
 desc "Shows stats of packets"
 arg_name "host"
 command :show_stats do | c |

data/features/.nav

@@ -6,6 +6,7 @@
   - up.feature
   - killall.feature
   - send_packets.feature
+  - port_down.feature
   - show_stats.feature
   - reset_stats.feature
   - dump_flows.feature
@@ -28,6 +29,8 @@
   - message.set_config.feature
   - message.vendor-action.feature
   - packetin_filter_config.feature
+- handlers:
+  - switch_ready.feature
 - core:
   - switch_manager.feature
   - packetin_filter.feature

data/features/handlers/switch_ready.feature

@@ -0,0 +1,40 @@
+Feature: switch_ready handler
+
+  The switch-ready is a message indicating a successful connection
+  established between a switch and your controller. If one wishes to
+  detect the connection-establishment event one must implement the
+  :switch_ready method in the controller class.
+
+  Note that the switch-ready message is not part of the OpenFlow spec,
+  but is a Trema-specific message. Internally, Trema::Controller
+  executes the following steps to emulate the switch-ready message.
+
+  1. Upon connection establishment with the switch a Hello message is
+  sent that completes a version negotiation sequence.
+  2. A Feature-Request message is sent awaiting for a Features-Reply
+  message from the switch.
+  3. Switch's state and flow tables are cleared/initialized to ensure
+  further correct operation.
+  4. Trema::Controller redirects a :switch_ready message to itself
+  with the switch's datapath-ID as its argument.
+
+  As Trema performs the above steps in the background, users are
+  unaware of such details. Users only need to handle the switch-ready
+  message.
+
+  @slow_process
+  Scenario: switch_ready handler
+    Given a file named "switch-ready-detector.rb" with:
+    """
+    class SwitchReadyDetector < Controller
+      def switch_ready datapath_id
+        info "Switch #{ datapath_id.to_hex } is UP"
+      end
+    end
+    """
+    And a file named "sample.conf" with:
+    """
+    vswitch { datapath_id "0xabc" }
+    """
+    When I run `trema run ./switch-ready-detector.rb -c sample.conf` interactively
+    Then the output should contain "Switch 0xabc is UP" within the timeout period

data/features/trema_commands/port_down.feature

@@ -0,0 +1,70 @@
+Feature: port_down command
+
+  Use this command to ensure that your controller detects network
+  topology changes i.e., failures in switches.
+
+  Trema emulated network offers a set of commands that can change the
+  status of any arbitrary switch port. The `trema port_down` is one
+  such command and its command syntax is as follows:
+
+      $ trema port_down --switch DATAPATH_ID --port PORT_NUMBER
+
+  The above command brings the switch's specified port down. By using
+  this command one can easily test the :port_status handler defined in
+  controllers.
+
+  Background:
+    Given a file named "sample.conf" with:
+    """
+    vswitch { datapath_id 0x1 }
+    vswitch { datapath_id 0x2 }
+
+    link "0x1", "0x2"
+    """
+    And a file named "port-observer.rb" with:
+    """
+    class PortObserver < Controller
+      def switch_ready dpid
+        info "Switch %#x is UP", dpid
+      end
+
+
+      def port_status dpid, message
+        if message.phy_port.down?
+          info "Port #{ message.phy_port.number } (Switch %#x) is DOWN", dpid
+        end
+      end
+    end
+    """
+
+  @slow_process
+  Scenario: trema port_down --switch 0x1 --port 1
+    Given I run `trema run ./port-observer.rb -c sample.conf` interactively
+    And I wait for output to contain "Switch 0x1 is UP"
+    When I run `trema port_down --switch 0x1 --port 1`
+    Then the output should contain "Port 1 (Switch 0x1) is DOWN" within the timeout period
+
+  @slow_process
+  Scenario: trema port_down --switch UNKNOWN --port 1 (unknown switch error)
+    Given I run `trema run ./port-observer.rb -c sample.conf -d`
+    When I run `trema port_down --switch UNKNOWN --port 1`
+    Then the output should contain "error: unknown switch: UNKNOWN"
+
+  @slow_process
+  Scenario: trema port_down --switch 0x1 --port 100 (unknown port error)
+    Given I run `trema run ./port-observer.rb -c sample.conf -d`
+    When I run `trema port_down --switch 0x1 --port 100`
+    Then the output should contain "error: ovs-ofctl: vsw_0x1: couldn't find port `100'"
+
+  @slow_process
+  Scenario: trema port_down --switch 0x1 (no --port option error)
+    Given I run `trema run ./port-observer.rb -c sample.conf -d`
+    When I run `trema port_down --switch 0x1`
+    Then the output should contain "error: --port option is mandatory"
+
+  @slow_process
+  Scenario: trema port_down --port 1 (no --switch option error)
+    Given I run `trema run ./port-observer.rb -c sample.conf -d`
+    When I run `trema port_down --port 1`
+    Then the output should contain "error: --switch option is mandatory"
+

data/ruby/trema/command.rb

@@ -22,6 +22,7 @@ require "trema/command/dump_flows"
 require "trema/command/kill"
 require "trema/command/killall"
 require "trema/command/netns"
+require "trema/command/port_down"
 require "trema/command/reset_stats"
 require "trema/command/ruby"
 require "trema/command/run"

data/ruby/trema/command/port_down.rb

@@ -0,0 +1,43 @@
+#
+# Copyright (C) 2008-2012 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.
+#
+
+
+require "trema/cli"
+require "trema/util"
+
+
+module Trema
+  module Command
+    include Trema::Util
+
+
+    def trema_port_down switch_name, port
+      switch = find_switch_by_name( switch_name )
+      raise "unknown switch: #{ switch_name }" if switch.nil?
+
+      error = switch.bring_port_down( port.to_i )
+      raise error if $?.exitstatus != 0
+    end
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8
+### indent-tabs-mode: nil
+### End:

data/ruby/trema/ofctl.rb

@@ -51,6 +51,11 @@ module Trema
     def dump_flows switch
       `sudo #{ Executables.ovs_ofctl } dump-flows #{ switch.network_device } 2>&1`
     end
+
+
+    def bring_port_down switch, port_number
+      `sudo #{ Executables.ovs_ofctl } mod-port #{ switch.network_device } #{ port_number } down 2>&1`
+    end
   end
 end
 

data/ruby/trema/open-vswitch.rb

@@ -97,6 +97,11 @@ module Trema
     end
 
 
+    def bring_port_down port_number
+      Ofctl.new.bring_port_down self, port_number
+    end
+
+
     ############################################################################
     private
     ############################################################################

data/ruby/trema/version.rb

@@ -17,7 +17,7 @@
 
 
 module Trema
-  VERSION = "0.3.6"
+  VERSION = "0.3.7"
 end
 
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: trema
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 29
   prerelease: 
   segments: 
   - 0
   - 3
-  - 6
-  version: 0.3.6
+  - 7
+  version: 0.3.7
 platform: ruby
 authors: 
 - Yasuhito Takamiya
@@ -15,7 +15,7 @@ autorequire:
 bindir: .
 cert_chain: []
 
-date: 2013-02-03 00:00:00 Z
+date: 2013-02-06 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   prerelease: false
@@ -150,6 +150,7 @@ files:
 - features/examples/repeater_hub.feature
 - features/examples/switch_info.feature
 - features/examples/switch_monitor.feature
+- features/handlers/switch_ready.feature
 - features/step_definitions/misc_steps.rb
 - features/step_definitions/send_packets_steps.rb
 - features/step_definitions/stats_steps.rb
@@ -161,6 +162,7 @@ files:
 - features/trema_commands/help_option.feature
 - features/trema_commands/kill.feature
 - features/trema_commands/killall.feature
+- features/trema_commands/port_down.feature
 - features/trema_commands/reset_stats.feature
 - features/trema_commands/run.feature
 - features/trema_commands/send_packets.feature
@@ -187,6 +189,7 @@ files:
 - ruby/trema/command/kill.rb
 - ruby/trema/command/killall.rb
 - ruby/trema/command/netns.rb
+- ruby/trema/command/port_down.rb
 - ruby/trema/command/reset_stats.rb
 - ruby/trema/command/ruby.rb
 - ruby/trema/command/run.rb