trema 0.2.7 → 0.2.8

data/Rakefile

@@ -53,6 +53,7 @@ begin
   RSpec::Core::RakeTask.new( :rcov ) do | spec |
     spec.pattern = "spec/**/*_spec.rb"
     spec.rcov = true
+    spec.rcov_opts = [ "-x", "gems" ]
   end
 rescue LoadError
   $stderr.puts $!.to_s

data/Rantfile

@@ -235,8 +235,9 @@ task :distclean => [
 gen Directory, Trema.objects
 
 task "vendor:openflow" => Trema.openflow_h
-file Trema.openflow_h => Trema.objects do
+file Trema.openflow_h do
   sys.unpack_tgz "#{ Trema.vendor_openflow }.tar.gz", :in => Trema.vendor
+  sys.mkdir_p Trema.objects
   sys.cp_r "#{ Trema.vendor_openflow }/include/openflow", Trema.objects
   sys "chmod -R +r #{ File.join Trema.objects, "openflow" }"
 end
@@ -379,7 +380,7 @@ end
 task dependency( "libtrema" ) => "vendor:openflow"
 gen C::Dependencies, dependency( "libtrema" ),
   :search => [ Trema.include, objects( "openflow" ) ],
-  :sources => sys[ "#{ Trema.include }/*.c" ]
+  :sources => sys[ "#{ Trema.include }/*.{c,h}" ]
 
 gen Action do
   source dependency( "libtrema" )
@@ -448,7 +449,7 @@ end
 switch_manager_objects_dir = objects( "switch_manager" )
 
 gen C::Dependencies, dependency( "switch_manager" ),
-  :search => [ "src/switch_manager", Trema.include ], :sources => sys[ "src/switch_manager/*.c" ]
+  :search => [ "src/switch_manager", Trema.include ], :sources => sys[ "src/switch_manager/*.{c,h}" ]
 
 gen Action do
   source dependency( "switch_manager" )
@@ -502,7 +503,7 @@ end
 ################################################################################
 
 gen C::Dependencies, dependency( "packetin_filter" ),
-  :search => [ "src/packetin_filter", Trema.include ], :sources => sys[ "src/packetin_filter/*.c" ]
+  :search => [ "src/packetin_filter", Trema.include ], :sources => sys[ "src/packetin_filter/*.{c,h}" ]
 
 gen Action do
   source dependency( "packetin_filter" )
@@ -529,7 +530,7 @@ end
 tremashark_objects_dir = objects( "tremashark" )
 
 gen C::Dependencies, dependency( "tremashark" ),
-  :search => [ "src/tremashark", Trema.include ], :sources => sys[ "src/tremashark/*.c" ]
+  :search => [ "src/tremashark", Trema.include ], :sources => sys[ "src/tremashark/*.{c,h}" ]
 
 gen Action do
   source dependency( "tremashark" )
@@ -613,7 +614,7 @@ management_source_dir = "src/management"
 management_objects_dir = objects( "management" )
 
 gen C::Dependencies, dependency( "management" ),
-  :search => [ Trema.include ], :sources => sys[ "#{ management_source_dir }/*.c" ]
+  :search => [ Trema.include ], :sources => sys[ "#{ management_source_dir }/*.{c,h}" ]
 
 gen Action do
   source dependency( "management" )
@@ -660,7 +661,7 @@ standalone_examples.each do | each |
   target = objects( "examples/#{ each }/#{ each }" )
 
   gen C::Dependencies, dependency( each ),
-    :search => [ "src/examples/#{ each }", Trema.include ], :sources => sys[ "src/examples/#{ each }/*.c" ]
+    :search => [ "src/examples/#{ each }", Trema.include ], :sources => sys[ "src/examples/#{ each }/*.{c,h}" ]
 
   gen Action do
     source dependency( each )
@@ -688,13 +689,14 @@ end
 
 openflow_switches = [
   "hello_switch",
+  "echo_switch",
 ]
 
 openflow_switch_source_dir = "src/examples/openflow_switch"
 openflow_switch_objects_dir = objects( "examples/openflow_switch" )
 
 gen C::Dependencies, dependency( "openflow_switch" ),
-  :search => [ Trema.include ], :sources => sys[ "#{ openflow_switch_source_dir }/*.c" ]
+  :search => [ Trema.include ], :sources => sys[ "#{ openflow_switch_source_dir }/*.{c,h}" ]
 
 gen Action do
   source dependency( "openflow_switch" )
@@ -722,8 +724,7 @@ end
 ################################################################################
 
 openflow_messages = [
-  "echo_reply",
-  "echo_request",
+  "echo",
   "features_request",
   "hello",
   "set_config",
@@ -734,7 +735,7 @@ openflow_message_source_dir = "src/examples/openflow_message"
 openflow_message_objects_dir = objects( "examples/openflow_message" )
 
 gen C::Dependencies, dependency( "openflow_message" ),
-  :search => [ Trema.include ], :sources => sys[ "#{ openflow_message_source_dir }/*.c" ]
+  :search => [ Trema.include ], :sources => sys[ "#{ openflow_message_source_dir }/*.{c,h}" ]
 
 gen Action do
   source dependency( "openflow_message" )
@@ -773,7 +774,7 @@ packetin_filter_config_source_dir = "src/examples/packetin_filter_config"
 packetin_filter_config_objects_dir = objects( "examples/packetin_filter_config" )
 
 gen C::Dependencies, dependency( "packetin_filter_config" ),
-  :search => [ Trema.include ], :sources => sys[ "#{ packetin_filter_config_source_dir }/*.c" ]
+  :search => [ Trema.include ], :sources => sys[ "#{ packetin_filter_config_source_dir }/*.{c,h}" ]
 
 gen Action do
   source dependency( "packetin_filter_config" )
@@ -836,7 +837,7 @@ end
 
 
 gen C::Dependencies, dependency( "unittests" ),
-  :search => [ Trema.include, "unittests" ], :sources => sys[ "unittests/lib/*.c", "src/lib/*.c" ]
+  :search => [ Trema.include, "unittests" ], :sources => sys[ "unittests/lib/*.c", "src/lib/*.{c,h}" ]
 
 gen Action do
   source dependency( "unittests" )

data/features/example.openflow_message.echo.feature

@@ -0,0 +1,59 @@
+Feature: Send echo request and receive echo reply messages
+
+  In order to hear heart beats from openflow switches
+  As a Trema user
+  I want to send echo request messages to openflow switches and receive echo replies
+
+  @slow_process
+  Scenario: Echo request and reply in C
+    Given a file named "echo.conf" with:
+      """
+      custom_switch("echo") { 
+        datapath_id "0xabc" 
+        path "./objects/examples/openflow_switch/echo_switch"
+      }
+      """
+    When I run `trema run "../../objects/examples/openflow_message/echo 10" -c echo.conf -d`
+      And wait until "echo" is up
+      And I run `trema killall`
+    Then the file "../../tmp/log/customswitch.echo.log" should contain:
+      """
+      received: OFPT_ECHO_REQUEST
+      received: OFPT_ECHO_REQUEST
+      received: OFPT_ECHO_REQUEST
+      received: OFPT_ECHO_REQUEST
+      received: OFPT_ECHO_REQUEST
+      received: OFPT_ECHO_REQUEST
+      received: OFPT_ECHO_REQUEST
+      received: OFPT_ECHO_REQUEST
+      received: OFPT_ECHO_REQUEST
+      received: OFPT_ECHO_REQUEST
+      """
+      And the file "../../tmp/log/echo.log" should match /received: OFPT_ECHO_REPLY/
+
+  @slow_process
+  Scenario: Echo request and reply in Ruby
+    Given a file named "echo.ruby.conf" with:
+      """
+      custom_switch("echo.ruby") { 
+        datapath_id "0xabc" 
+        path "./objects/examples/openflow_switch/echo_switch"
+      }
+      """
+    When I run `trema run "../../src/examples/openflow_message/echo.rb 0xabc, 10" -c echo.ruby.conf -d`
+      And wait until "EchoController" is up
+      And I run `trema killall`
+    Then the file "../../tmp/log/customswitch.echo.ruby.log" should contain:
+      """
+      received: OFPT_ECHO_REQUEST
+      received: OFPT_ECHO_REQUEST
+      received: OFPT_ECHO_REQUEST
+      received: OFPT_ECHO_REQUEST
+      received: OFPT_ECHO_REQUEST
+      received: OFPT_ECHO_REQUEST
+      received: OFPT_ECHO_REQUEST
+      received: OFPT_ECHO_REQUEST
+      received: OFPT_ECHO_REQUEST
+      received: OFPT_ECHO_REQUEST
+      """
+      # And the file "../../tmp/log/EchoController.log" should match /received: OFPT_ECHO_REPLY/

data/ruby/trema/mac.rb

@@ -63,6 +63,8 @@ module Trema
         when Integer
           @value = value
           validate_value_range
+        when Mac
+          @value = create_from( value.to_s )
         else
           raise TypeError, "Invalid MAC address: #{ value.inspect }"
       end

data/ruby/trema/set-eth-dst-addr.rb

@@ -30,12 +30,13 @@ module Trema
     # @example
     #   SetEthDstAddr.new("11:22:33:44:55:66")
     #   SetEthDstAddr.new(0x112233445566)
+    #   SetEthDstAddr.new(mac)
     #
-    # @param [String,Integer] mac_address
+    # @param [String,Integer,Mac] mac_address
     #   the Ethernet address to create this action with.
     #
     # @raise [ArgumentError] if invalid format is detected.
-    # @raise [TypeError] if supplied argument is not a String or Integer.
+    # @raise [TypeError] if supplied argument is not a String or Integer or Mac.
     #
     def initialize mac_address
       super mac_address

data/ruby/trema/set-eth-src-addr.rb

@@ -30,12 +30,13 @@ module Trema
     # @example
     #   SetEthSrcAddr.new("11:22:33:44:55:66")
     #   SetEthSrcAddr.new(0x112233445566)
+    #   SetEthSrcAddr.new(mac)
     #
-    # @param [String,Integer] mac_address
+    # @param [String,Integer,Mac] mac_address
     #   the Ethernet address to create this action with.
     #
     # @raise [ArgumentError] if invalid format is detected.
-    # @raise [TypeError] if supplied argument is not a String or Integer.
+    # @raise [TypeError] if supplied argument is not a String or Integer or Mac.
     #
     def initialize mac_address
       super mac_address

data/ruby/trema/version.rb

@@ -17,7 +17,7 @@
 
 
 module Trema
-  VERSION = "0.2.7"
+  VERSION = "0.2.8"
 end
 
 

data/spec/spec_helper.rb

@@ -25,6 +25,7 @@ $LOAD_PATH.unshift File.expand_path( File.join File.dirname( __FILE__ ), "..", "
 require "rubygems"
 
 require "rspec"
+require "rspec/autorun"
 require "trema"
 require "trema/dsl/configuration"
 require "trema/dsl/context"

data/spec/trema/set-eth-dst-addr_spec.rb

@@ -26,6 +26,12 @@ describe SetEthDstAddr, %{.new( "52:54:00:a8:ad:8c" )} do
 end
 
 
+describe SetEthDstAddr, %{.new( Mac.new( "52:54:00:a8:ad:8c" ) )} do
+  subject { SetEthDstAddr.new( Mac.new( "52:54:00:a8:ad:8c" ) )}
+  its( :mac_address ) { should == Mac.new( "52:54:00:a8:ad:8c" ) }
+end
+
+
 describe SetEthDstAddr, %{.new( "INVALID MAC STRING" )} do
   it { expect { SetEthDstAddr.new( "INVALID MAC STRING" ) }.to raise_error( ArgumentError ) }
 end

data/spec/trema/set-eth-src-addr_spec.rb

@@ -26,6 +26,12 @@ describe SetEthSrcAddr, %{.new( "52:54:00:a8:ad:8c" )} do
 end
 
 
+describe SetEthSrcAddr, %{.new( Mac.new( "52:54:00:a8:ad:8c" ) )} do
+  subject { SetEthSrcAddr.new( Mac.new( "52:54:00:a8:ad:8c" ) )}
+  its( :mac_address ) { should == Mac.new( "52:54:00:a8:ad:8c" ) }
+end
+
+
 describe SetEthSrcAddr, %{.new( "INVALID MAC STRING" )} do
   it { expect { SetEthSrcAddr.new( "INVALID MAC STRING" ) }.to raise_error( ArgumentError ) }
 end

data/src/examples/openflow_message/{echo_request.c → echo.c}

@@ -1,8 +1,6 @@
 /*
  * Sends echo_request messages to the specified datapath ID.
  *
- * Author: Shin-ya Zenke, Yasuhito Takamiya <yasuhito@gmail.com>
- *
  * Copyright (C) 2008-2012 NEC Corporation
  *
  * This program is free software; you can redistribute it and/or modify
@@ -44,6 +42,17 @@ send_echo_requests( uint64_t datapath_id, void *count ) {
 }
 
 
+static void
+handle_echo_reply( uint64_t datapath_id, uint32_t xid, const buffer *data, void *user_data ) {
+  UNUSED( datapath_id );
+  UNUSED( xid );
+  UNUSED( data );
+  UNUSED( user_data );
+
+  info( "received: OFPT_ECHO_REPLY" );
+}
+
+
 int
 main( int argc, char *argv[] ) {
   init_trema( &argc, &argv );
@@ -55,6 +64,7 @@ main( int argc, char *argv[] ) {
 
   int count = atoi( argv[ 1 ] );
   set_switch_ready_handler( send_echo_requests, &count );
+  set_echo_reply_handler( handle_echo_reply, NULL );
 
   start_trema();
 

data/src/examples/openflow_message/{echo-request.rb → echo.rb}

@@ -23,7 +23,7 @@
 require  "example"
 
 
-class EchoRequestController < Controller
+class EchoController < Controller
   include Example
 
 
@@ -48,7 +48,7 @@ class EchoRequestController < Controller
 end
 
 
-EchoRequestController.run ARGV
+EchoController.run ARGV
 
 
 ### Local variables:

data/src/examples/openflow_switch/echo_switch.c

@@ -0,0 +1,89 @@
+/*
+ * A simple switch that has minimum function to test echo message.
+ *
+ * Copyright (C) 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.
+ */
+
+
+#include "chibach.h"
+
+
+// FIXME: Copy & Paste from hello_switch.c
+static void
+handle_features_request( uint32_t xid, void *user_data ) {
+  UNUSED( user_data );
+
+  uint32_t supported = ( ( 1 << OFPAT_OUTPUT ) |
+                         ( 1 << OFPAT_SET_VLAN_VID ) |
+                         ( 1 << OFPAT_SET_VLAN_PCP ) |
+                         ( 1 << OFPAT_STRIP_VLAN ) |
+                         ( 1 << OFPAT_SET_DL_SRC ) |
+                         ( 1 << OFPAT_SET_DL_DST ) |
+                         ( 1 << OFPAT_SET_NW_SRC ) |
+                         ( 1 << OFPAT_SET_NW_DST ) |
+                         ( 1 << OFPAT_SET_NW_TOS ) |
+                         ( 1 << OFPAT_SET_TP_SRC ) |
+                         ( 1 << OFPAT_SET_TP_DST ) );
+
+  buffer *msg = create_features_reply( xid, get_datapath_id(), 0, 1, 0, supported, NULL );
+
+  switch_send_openflow_message( msg );
+}
+
+
+// FIXME: Copy & Paste from hello_switch.c
+static void
+handle_hello( uint32_t xid, uint8_t version, void *user_data ) {
+  UNUSED( version );
+  UNUSED( user_data );
+
+  switch_send_openflow_message( create_hello( xid ) );
+}
+
+
+static void
+handle_echo_request( uint32_t xid, const buffer *body, void *user_data ) {
+  UNUSED( body );
+  UNUSED( user_data );
+
+  info( "received: OFPT_ECHO_REQUEST" );
+
+  switch_send_openflow_message( create_echo_reply( xid, NULL ) );
+}
+
+
+int
+main( int argc, char **argv ) {
+  init_chibach( &argc, &argv );
+
+  set_hello_handler( handle_hello, NULL );
+  set_features_request_handler( handle_features_request, NULL );
+  set_echo_request_handler( handle_echo_request, NULL );
+
+  start_chibach();
+
+  stop_chibach();
+
+  return 0;
+}
+
+
+/*
+ * Local variables:
+ * c-basic-offset: 2
+ * indent-tabs-mode: nil
+ * End:
+ */

data/src/examples/openflow_switch/hello_switch.c

@@ -21,40 +21,44 @@
 #include "chibach.h"
 
 
-static void handle_features_request( uint32_t, void * );
-static void handle_hello( uint32_t, uint8_t, void * );
-
-
 static void
-handle_features_request( uint32_t tid, void *user_data ) {
+handle_features_request( uint32_t xid, void *user_data ) {
   UNUSED( user_data );
 
-  uint32_t supported = ( ( 1 << OFPAT_OUTPUT ) | 
-                         ( 1 << OFPAT_SET_VLAN_VID ) | 
-                         ( 1 << OFPAT_SET_VLAN_PCP ) | 
-                         ( 1 << OFPAT_STRIP_VLAN ) | 
-                         ( 1 << OFPAT_SET_DL_SRC ) | 
-                         ( 1 << OFPAT_SET_DL_DST ) | 
-                         ( 1 << OFPAT_SET_NW_SRC ) | 
-                         ( 1 << OFPAT_SET_NW_DST ) | 
-                         ( 1 << OFPAT_SET_NW_TOS ) | 
-                         ( 1 << OFPAT_SET_TP_SRC ) | 
+  uint32_t supported = ( ( 1 << OFPAT_OUTPUT ) |
+                         ( 1 << OFPAT_SET_VLAN_VID ) |
+                         ( 1 << OFPAT_SET_VLAN_PCP ) |
+                         ( 1 << OFPAT_STRIP_VLAN ) |
+                         ( 1 << OFPAT_SET_DL_SRC ) |
+                         ( 1 << OFPAT_SET_DL_DST ) |
+                         ( 1 << OFPAT_SET_NW_SRC ) |
+                         ( 1 << OFPAT_SET_NW_DST ) |
+                         ( 1 << OFPAT_SET_NW_TOS ) |
+                         ( 1 << OFPAT_SET_TP_SRC ) |
                          ( 1 << OFPAT_SET_TP_DST ) );
 
-	buffer *msg = create_features_reply( tid, get_datapath_id(), 0, 1, 0, supported, NULL );
-
-  switch_send_openflow_message( msg );
+  buffer *features_reply = create_features_reply(
+    xid,
+    get_datapath_id(),
+    0,
+    1,
+    0,
+    supported,
+    NULL
+  );
+
+  switch_send_openflow_message( features_reply );
 }
 
 
 static void
-handle_hello( uint32_t tid, uint8_t version, void *user_data ) {
+handle_hello( uint32_t xid, uint8_t version, void *user_data ) {
   UNUSED( version );
   UNUSED( user_data );
 
   info( "received: OFPT_HELLO" );
 
-  switch_send_openflow_message( create_hello( tid ) );
+  switch_send_openflow_message( create_hello( xid ) );
 }
 
 

data/src/examples/simple_router/arp-table.rb

@@ -0,0 +1,92 @@
+#
+# ARP processing routines
+#
+# Copyright (C) 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 ARPEntry
+  include Trema::Logger
+
+
+  attr_reader :port
+  attr_reader :hwaddr
+  attr_writer :age_max
+
+
+  def initialize port, hwaddr, age_max
+    @port = port
+    @hwaddr = hwaddr
+    @age_max = age_max
+    @last_updated = Time.now
+    info "New entry: MAC addr = #{ @hwaddr.to_s }, port = #{ @port }"
+  end
+
+
+  def update port, hwaddr
+    @port = port
+    @hwaddr = hwaddr
+    @last_updated = Time.now
+    info "Update entry: MAC addr = #{ @hwaddr.to_s }, port = #{ @port }"
+  end
+
+
+  def aged_out?
+    aged_out = Time.now - @last_updated > @age_max
+    info "Age out: An ARP entry (MAC address = #{ @hwaddr.to_s }, port number = #{ @port }) has been aged-out" if aged_out
+    aged_out
+  end
+end
+
+
+class ARPTable
+  DEFAULT_AGE_MAX = 300
+
+
+  def initialize
+    @db = {}
+  end
+
+
+  def update port, ipaddr, hwaddr
+    entry = @db[ ipaddr.to_i ]
+    if entry
+      entry.update( port, hwaddr )
+    else
+      new_entry = ARPEntry.new( port, hwaddr, DEFAULT_AGE_MAX )
+      @db[ ipaddr.to_i ] = new_entry
+    end
+  end
+
+
+  def lookup ipaddr
+    @db[ ipaddr.to_i ]
+  end
+
+
+  def age
+    @db.delete_if do | ipaddr, entry |
+      entry.aged_out?
+    end
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/src/examples/simple_router/interface.rb

@@ -0,0 +1,99 @@
+#
+# A router implementation in Trema
+#
+# Copyright (C) 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 "arp-table"
+require "routing-table"
+
+
+class Interface
+  attr_reader :hwaddr
+  attr_reader :ipaddr
+  attr_reader :masklen
+  attr_reader :port
+
+
+  def initialize options
+    @port = options[ :port ]
+    @hwaddr = Mac.new( options[ :hwaddr ] )
+    @ipaddr = IPAddr.new( options[ :ipaddr ] )
+    @masklen = options[ :masklen ]
+  end
+
+
+  def has? mac
+    mac == hwaddr
+  end
+end
+
+
+class Interfaces
+  def initialize interfaces = []
+    @list = []
+    interfaces.each do | each |
+      @list << Interface.new( each )
+    end
+  end
+
+
+  def find_by_port port
+    @list.find do | each |
+      each.port == port
+    end
+  end
+
+
+  def find_by_ipaddr ipaddr
+    @list.find do | each |
+      each.ipaddr == ipaddr
+    end
+  end
+
+
+  def find_by_prefix ipaddr
+    @list.find do | each |
+      masklen = each.masklen
+      each.ipaddr.mask( masklen ) == ipaddr.mask( masklen )
+    end
+  end
+
+
+  def find_by_port_and_ipaddr port, ipaddr
+    @list.find do | each |
+      each.port == port and each.ipaddr == ipaddr
+    end
+  end
+
+
+  def ours? port, macda
+    return true if macda.broadcast?
+
+    interface = find_by_port( port )
+    if not interface.nil? and interface.has?( macda )
+      return true
+    end
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8
+### indent-tabs-mode: nil
+### End: