trema 0.1.3

data/features/trema.reset_stats.feature

@@ -0,0 +1,14 @@
+Feature: reset network stats with `trema reset_stats' command
+
+  As a Trema user
+  I want to reset network stats with `trema reset_stats' command
+  So that I can easily debug trema applications
+
+  Scenario: trema help reset_stats
+    When I try to run "./trema help reset_stats"
+    Then the output should be:
+      """
+      Usage: ./trema reset_stats [OPTIONS ...]
+          -h, --help
+          -v, --verbose
+      """

data/features/trema.run.feature

@@ -0,0 +1,46 @@
+Feature: run trema application with `trema run' command
+
+  As a Trema user
+  I want to launch trema applications with `trema run' command
+  So that I don't have to mind the details of Trema
+
+
+  Scenario: trema run launches switch_manager and an application
+    When I try trema run "./objects/examples/dumper/dumper" with following configuration (backgrounded):
+      """
+      vswitch { datapath_id "0xabc" }
+      """
+      And wait until "dumper" is up
+    Then switch_manager is started
+      And dumper is started
+
+
+  Scenario: trema run launches switch_manager and an application with proper options
+    When I try trema run "./objects/examples/learning_switch/learning_switch -i 0xabc" with following configuration (backgrounded, verbose):
+      """
+      vswitch { datapath_id "0xabc" }
+      """
+      And wait until "learning_switch" is up
+    Then "switch_manager" should be executed with option = "--daemonize --port=6633 -- port_status::learning_switch packet_in::learning_switch state_notify::learning_switch"
+      And "learning_switch" should be executed with option = "--name learning_switch -i 0xabc"
+
+
+  Scenario: switch_manager is killed when trema session is closed
+    When I try trema run "/bin/true" with following configuration (verbose):
+      """
+      vswitch { datapath_id "0xabc" }
+      """
+    Then switch_manager should be killed
+
+
+  Scenario: trema help run
+    When I try to run "./trema help run"
+    Then the output should be:
+      """
+      Usage: ./trema run [OPTIONS ...]
+          -c, --conf FILE
+          -d, --daemonize
+
+          -h, --help
+          -v, --verbose
+      """

data/features/trema.send_packets.feature

@@ -0,0 +1,56 @@
+Feature: send packets with `trema send_packets' command
+
+  As a Trema user
+  I want to send network packets with `trema send_packets' command
+  So that I can easily debug trema applications
+
+
+  Background:
+    Given I try trema run "learning_switch" example with following configuration (backgrounded):
+      """
+      vswitch { datapath_id "0xabc" }
+
+      vhost("host1") { ip "192.168.0.1" }
+      vhost("host2") { ip "192.168.0.2" }
+
+      link "0xabc", "host1"
+      link "0xabc", "host2"
+      """
+
+
+  Scenario: send_packets error (--source)
+    Then "./trema send_packets --source NO_SUCH_HOST --dest host2" exits abnormally with an error message:
+      """
+      Unknown host: NO_SUCH_HOST
+      """
+
+
+  Scenario: send_packets error (--dest)
+    Then "./trema send_packets --dest host1 --dest NO_SUCH_HOST" exits abnormally with an error message:
+      """
+      Unknown host: NO_SUCH_HOST
+      """
+
+
+  Scenario: trema help send_packets
+    When I try to run "./trema help send_packets"
+    Then the output should be:
+      """
+      Usage: ./trema send_packets --source HOSTNAME --dest HOSTNAME [OPTIONS ...]
+          -s, --source HOSTNAME
+              --inc_ip_src [NUMBER]
+          -d, --dest HOSTNAME
+              --inc_ip_dst [NUMBER]
+              --tp_src NUMBER
+              --inc_tp_src [NUMBER]
+              --tp_dst NUMBER
+              --inc_tp_dst [NUMBER]
+              --pps NUMBER
+              --n_pkts NUMBER
+              --duration NUMBER
+              --length NUMBER
+              --inc_payload [NUMBER]
+
+          -h, --help
+          -v, --verbose
+      """

data/features/trema.show_stats.feature

@@ -0,0 +1,67 @@
+Feature: show network stats with `trema show_stats' command
+
+  As a Trema user
+  I want to get packet stats with `trema show_stats' command
+  So that I can easily debug trema applications
+
+
+  Background:
+    Given I try trema run "learning_switch" example with following configuration (backgrounded):
+      """
+      vswitch { datapath_id "0xabc" }
+
+      vhost("host1") { ip "192.168.0.1" }
+      vhost("host2") { ip "192.168.0.2" }
+
+      link "0xabc", "host1"
+      link "0xabc", "host2"
+      """
+
+
+  Scenario: show_stats
+    When I send 1 packet from host1 to host2
+    Then the stats of "host1" should be:
+      """
+      Sent packets:
+      ip_dst,tp_dst,ip_src,tp_src,n_pkts,n_octets
+      192.168.0.2,1,192.168.0.1,1,1,50
+      Received packets:
+      """
+
+
+  Scenario: show_stats --tx
+    When I send 1 packet from host1 to host2
+    Then the tx stats of "host1" should be:
+      """
+      ip_dst,tp_dst,ip_src,tp_src,n_pkts,n_octets
+      192.168.0.2,1,192.168.0.1,1,1,50
+      """
+
+
+  Scenario: show_stats --rx
+    When I send 1 packet from host1 to host2
+    Then the rx stats of "host2" should be:
+      """
+      ip_dst,tp_dst,ip_src,tp_src,n_pkts,n_octets
+      192.168.0.2,1,192.168.0.1,1,1,50
+      """
+
+
+  Scenario: show_stats error
+    Then "./trema show_stats NO_SUCH_HOST" exits abnormally with an error message:
+      """
+      Unknown host: NO_SUCH_HOST
+      """
+
+
+  Scenario: trema help show_stats
+    When I try to run "./trema help show_stats"
+    Then the output should be:
+      """
+      Usage: ./trema show_stats HOSTNAME [OPTIONS ...]
+          -t, --tx
+          -r, --rx
+
+          -h, --help
+          -v, --verbose
+      """

data/features/tutorial.hello_trema.feature

@@ -0,0 +1,27 @@
+Feature: Hello trema sample application
+
+  As a Trema user
+  I want to write "hello trema" application
+  So that I can learn how to write minimum trema application
+
+
+  Scenario: Hello trema in C
+    When I try trema run "./objects/examples/hello_trema/hello_trema" with following configuration:
+      """
+      vswitch { datapath_id "0xabc" }
+      """
+    Then the output should include:
+      """
+      Hello 0xabc from ./objects/examples/hello_trema/hello_trema!
+      """
+
+
+  Scenario: Hello trema in Ruby
+    When I try trema run "./src/examples/hello_trema/hello_trema.rb" with following configuration:
+      """
+      vswitch { datapath_id "0xabc" }
+      """
+    Then the output should include:
+      """
+      Hello 0xabc from ./src/examples/hello_trema/hello_trema.rb!
+      """

data/features/tutorial.packet_in.feature

@@ -0,0 +1,47 @@
+Feature: Tutorial: Handling packet_in events example
+
+  As a Trema user
+  I want to respond to packet_in events
+  So that I can handle unknown packets
+
+
+  Scenario: Handle packet_in
+    When I try trema run "./objects/examples/packet_in/packet_in" with following configuration (backgrounded):
+      """
+      vswitch("packet_in") { dpid "0xabc" }
+
+      vhost("host1")
+      vhost("host2")
+
+      link "packet_in", "host1"
+      link "packet_in", "host2"
+      """
+      And wait until "packet_in" is up
+      And I try to run "./trema send_packets --source host1 --dest host2"
+      And *** sleep 2 ***
+      And I terminated all trema services
+    Then the output should include:
+      """
+      received a packet_in
+      """
+
+
+  Scenario: Handle packet_in in Ruby
+    When I try trema run "./src/examples/packet_in/packet_in.rb" with following configuration (backgrounded):
+      """
+      vswitch("packet_in") { dpid "0xabc" }
+
+      vhost("host1")
+      vhost("host2")
+
+      link "packet_in", "host1"
+      link "packet_in", "host2"
+      """
+      And wait until "PacketinDumper" is up
+      And I try to run "./trema send_packets --source host1 --dest host2"
+      And *** sleep 2 ***
+      And I terminated all trema services
+    Then the output should include:
+      """
+      received a packet_in
+      """

data/features/tutorial.switch_info.feature

@@ -0,0 +1,55 @@
+Feature: "Getting switch info" sample application
+
+  As a Trema user
+  I want to write "Getting switch info" application
+  So that I can learn how to acquire the information of openflow switches
+
+
+  Scenario: Getting switch info in C
+    When I try trema run "./objects/examples/switch_info/switch_info" with following configuration:
+      """
+      vswitch { datapath_id "0xabc" }
+      """
+    Then the output should include:
+      """
+      datapath_id: 0xabc
+      #ports: 1
+      """
+
+
+  Scenario: Getting switch info in C
+    When I try trema run "./objects/examples/switch_info/switch_info" with following configuration:
+      """
+      vswitch { datapath_id "0xabc" }
+      vswitch { datapath_id "0xdef" }
+      link "0xabc", "0xdef"
+      """
+    Then the output should include:
+      """
+      #ports: 2
+      """
+
+
+  Scenario: Getting switch info in Ruby
+    When I try trema run "./src/examples/switch_info/switch_info.rb" with following configuration:
+      """
+      vswitch { datapath_id "0xabc" }
+      """
+    Then the output should include:
+      """
+      datapath_id: 0xabc
+      ports: 65534
+      """
+
+
+  Scenario: Getting switch info in Ruby
+    When I try trema run "./src/examples/switch_info/switch_info.rb" with following configuration:
+      """
+      vswitch { datapath_id "0xabc" }
+      vswitch { datapath_id "0xdef" }
+      link "0xabc", "0xdef"
+      """
+    Then the output should include:
+      """
+      ports: 1, 65534
+      """

data/ruby/.gitignore

@@ -0,0 +1,4 @@
+*.o
+Makefile
+mkmf.log
+trema.so

data/ruby/blocker.rb

@@ -0,0 +1,78 @@
+#
+# Executes a block exclusively.
+#
+#
+# == Example:
+#
+#  Blocker.start do
+#    # do smething here.
+#  end
+#
+#
+# == Credit:
+#
+# Author: Yasuhito Takamiya <yasuhito@gmail.com>
+#
+# 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.
+#
+
+
+class Blocker
+  class BlockerError < RuntimeError; end
+
+
+  PATH = "/tmp/cruise.lock"
+
+
+  def self.start &code_block
+    begin
+      block
+      code_block.call
+    rescue BlockerError, Errno::EACCES
+      $stderr.puts "Another process is already running. Please wait for a while."
+      sleep 10
+      retry
+    ensure
+      release
+    end
+  end
+
+
+  def self.block
+    lock = File.open( PATH, "a+" )
+    locked = lock.flock( File::LOCK_EX | File::LOCK_NB )
+    unless locked
+      lock.close
+      raise BlockerError
+    end
+  end
+
+
+  def self.release
+    File.open( PATH, "w" ) do | lock |
+      lock.flock( File::LOCK_UN | File::LOCK_NB )
+      lock.close
+      File.delete lock.path
+    end
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/ruby/extconf.rb

@@ -0,0 +1,71 @@
+#
+# Author: Yasuhito Takamiya <yasuhito@gmail.com>
+#
+# 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 "mkmf"
+
+
+$CFLAGS = "-g -std=gnu99 -D_GNU_SOURCE -fno-strict-aliasing -Wall -Wextra -Wformat=2 -Wcast-qual -Wcast-align -Wwrite-strings -Wconversion -Wfloat-equal -Wpointer-arith"
+$LDFLAGS = "-Wl,-Bsymbolic"
+
+
+dir_config "trema"
+dir_config "openflow"
+
+
+def error_exit message
+  $stderr.puts message
+  exit false
+end
+
+
+def error_lib_missing lib, package
+  return <<-EOF
+ERROR: #{ lib } not found!
+
+Please install #{ package } with following command:
+% sudo apt-get install #{ package }
+EOF
+end
+
+
+unless find_library( "rt", "clock_gettime" )
+  error_exit error_lib_missing( "librt", "libc6-dev" )
+end
+
+unless find_library( "dl", "dlopen" )
+  error_exit error_lib_missing( "libdl", "libc6-dev" )
+end
+
+unless find_library( "sqlite3", "sqlite3_open" )
+  error_exit error_lib_missing( "libsqlite3", "libsqlite3-dev" )
+end
+
+unless find_library( "trema", "create_hello" )
+  error_exit <<-EOF
+ERROR: Trema is not compiled yet!
+
+Please try the following command:
+% ./build.rb
+EOF
+end
+
+
+create_makefile "trema", "trema"
+