trema 0.2.2.1 → 0.2.3

data/ruby/trema/controller.rb

@@ -1,6 +1,4 @@
 #
-# Author: Yasuhito Takamiya <yasuhito@gmail.com>
-#
 # Copyright (C) 2008-2012 NEC Corporation
 #
 # This program is free software; you can redistribute it and/or modify
@@ -19,6 +17,7 @@
 
 
 require "trema/app"
+require "trema/logger"
 require "trema/monkey-patch/integer"
 require "trema/monkey-patch/string"
 require "trema/timers"
@@ -29,6 +28,7 @@ module Trema
   # The base class of Trema controller.
   #
   class Controller < App
+    include Logger
     include Timers
 
 

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

@@ -0,0 +1,77 @@
+#
+# Author: Nick Karanatsios <nickkaranatsios@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 "trema/stats-helper"
+
+
+module Trema
+  class DescStatsReply < StatsHelper
+    FIELDS = %w(mfr_desc hw_desc sw_desc serial_num dp_desc ) 
+    FIELDS.each { |field| attr_reader field.intern }
+
+    
+    # Descriptive information about a vswitch.
+    # A user would not explicitly instantiate a {DescStatsReply} object but
+    # would be created as a result of parsing the +OFPT_STATS_REPLY(OFPST_DESC)+
+    # message.
+    #
+    # @overload initialize(options={})
+    #
+    #   @example 
+    #     DescStatsReply.new(
+    #       :mfr_desc => "Nicira Networks, Inc.",
+    #       :hw_desc => "Open vSwitch", 
+    #       :sw_desc => "1.2.2"
+    #       :serial_num => "None"
+    #     )
+    #
+    #   @param [Hash] options
+    #     the options to create this instance with.
+    #
+    #   @option options [String] :mfr_desc
+    #     the manufacturer description.
+    #
+    #   @option options [String] :hw_desc
+    #     the hardware description.
+    #
+    #   @option options [String] :sw_desc
+    #     the software description.
+    #
+    #   @option options [String] :serial_num
+    #     the serial number.
+    #
+    #   @option options [String] :dp_desc
+    #     the human readable description of datapath.
+    #
+    #   @return [DescStatsReply]
+    #     an object that encapsulates the OFPST_STATS_REPLY(OFPST_DESC) OpenFlow message.
+    #
+    def initialize options 
+      super FIELDS, options
+    end
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/ruby/trema/dsl/configuration.rb

@@ -21,8 +21,8 @@
 require "trema/app"
 require "trema/host"
 require "trema/link"
+require "trema/openflow-switch"
 require "trema/packetin-filter"
-require "trema/switch"
 require "trema/switch-manager"
 
 
@@ -42,16 +42,6 @@ module Trema
       #
       attr_accessor :port
 
-      #
-      # use tremashark?
-      #
-      # @example
-      #   config.tremashark = true
-      #
-      # @return [Boolean]
-      #
-      attr_accessor :tremashark
-
       #
       # the hash of {App}
       #
@@ -90,7 +80,7 @@ module Trema
       #
       # @example
       #   p config.switches
-      #   #=> {"switch #0"=>#<Trema::Switch:0xb73c9328>, ...}
+      #   #=> {"switch #0"=>#<Trema::OpenflowSwitch:0xb73c9328>, ...}
       #
       # @return [Hash]
       #
@@ -107,13 +97,12 @@ module Trema
       #
       def initialize
         @port = 6633
-        @tremashark = false
         @apps = Trema::App.clear
         @hosts = Trema::Host.clear
         @links = Trema::Link.clear
         @packetin_filter = Trema::PacketinFilter.clear
         @switch_manager = Trema::SwitchManager.clear
-        @switches = Trema::Switch.clear
+        @switches = Trema::OpenflowSwitch.clear
       end
 
 

data/ruby/trema/dsl/rswitch.rb

@@ -0,0 +1,47 @@
+#
+# The syntax definition of rswitch { ... } stanza in Trema DSL.
+#
+# 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/dsl/switch"
+
+
+module Trema
+  module DSL
+    class Rswitch < Switch
+      attr_reader :path
+
+
+      def initialize name = nil
+        super name
+      end
+
+
+      def file path
+        @path = path
+      end
+    end
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/ruby/trema/dsl/runner.rb

@@ -20,6 +20,9 @@
 #
 
 
+require "trema/tremashark"
+
+
 module Trema
   module DSL
     class Runner
@@ -89,7 +92,7 @@ module Trema
 
 
       def maybe_run_tremashark
-        @context.tremashark.run if @context.tremashark
+        Trema::Tremashark.new.run if $use_tremashark
       end
 
 

data/ruby/trema/dsl/syntax.rb

@@ -22,18 +22,19 @@
 
 require "trema/app"
 require "trema/dsl/link"
+require "trema/dsl/rswitch"
 require "trema/dsl/run"
 require "trema/dsl/switch"
 require "trema/dsl/vhost"
 require "trema/dsl/vswitch"
+require "trema/hardware-switch"
 require "trema/host"
 require "trema/link"
 require "trema/monkey-patch/module"
 require "trema/open-vswitch"
-require "trema/openflow-switch"
 require "trema/packetin-filter"
+require "trema/ruby-switch"
 require "trema/switch-manager"
-require "trema/tremashark"
 
 
 module Trema
@@ -44,11 +45,6 @@ module Trema
       end
 
 
-      def use_tremashark
-        @config.tremashark = Trema::Tremashark.new
-      end
-
-
       def port number
         @config.port = number
       end
@@ -63,7 +59,7 @@ module Trema
       def switch name = nil, &block
         stanza = Trema::DSL::Switch.new( name )
         stanza.instance_eval( &block )
-        Trema::OpenflowSwitch.new( stanza )
+        Trema::HardwareSwitch.new( stanza )
       end
 
 
@@ -74,6 +70,13 @@ module Trema
       end
 
 
+      def rswitch name = nil, &block
+        stanza = Trema::DSL::Rswitch.new( name )
+        stanza.instance_eval( &block )
+        Trema::RubySwitch.new( stanza )
+      end
+
+
       def vhost name = nil, &block
         stanza = Trema::DSL::Vhost.new( name )
         stanza.instance_eval( &block ) if block

data/ruby/trema/echo-reply.c

@@ -1,6 +1,4 @@
 /*
- * Author: Nick Karanatsios <nickkaranatsios@gmail.com>
- *
  * Copyright (C) 2008-2012 NEC Corporation
  *
  * This program is free software; you can redistribute it and/or modify
@@ -18,8 +16,10 @@
  */
 
 
-#include "trema.h"
+#include "echo.h"
 #include "ruby.h"
+#include "trema.h"
+#include "trema-ruby-utils.h"
 
 
 extern VALUE mTrema;
@@ -28,74 +28,88 @@ VALUE cEchoReply;
 
 static VALUE
 echo_reply_alloc( VALUE klass ) {
-  buffer *echo_reply = create_echo_reply( get_transaction_id(), NULL );
+  buffer *body = alloc_buffer();
+  buffer *echo_reply = create_echo_reply( 0, body );
+  free_buffer( body );
   return Data_Wrap_Struct( klass, NULL, free_buffer, echo_reply );
 }
 
 
+#if 0
 /*
- * Creates a {EchoReply} instance.
- *
- * @overload initialize(options={})
+ * Creates a EchoReply OpenFlow message. This message can be used to
+ * measure the bandwidth of a controller/switch connection as well as
+ * to verify its liveness.
  *
+ * @overload initialize()
  *   @example
  *     EchoReply.new
- *     EchoReply.new( :transaction_id => 123 )
  *
+ * @overload initialize(transaction_id)
+ *   @example
+ *     EchoReply.new( 123 )
+ *   @param [Integer] transaction_id
+ *     An unsigned 32bit integer number associated with this message.
+ *
+ * @overload initialize(options)
+ *   @example
+ *     EchoReply.new(
+ *       :transaction_id => transaction_id,
+ *       :user_data => "Thu Aug 25 13:09:00 +0900 2011"
+ *     )
  *   @param [Hash] options
  *     the options to create a message with.
- *
+ *   @option options [Number] :xid
  *   @option options [Number] :transaction_id
- *     An unsigned 32-bit integer auto-generated if not supplied.
- *
- *   @raise [ArgumentError] if transaction id is not an unsigned 32-bit integer.
- *   @raise [TypeError] if options is not a hash.
+ *     An unsigned 32bit integer number associated with this message.
+ *     If not specified, an auto-generated value is set.
+ *   @option options [String] :user_data
+ *     the user data field specified as a String may be a message timestamp to check latency,
+ *     various lengths to measure bandwidth or zero-size(nil) to verify liveness between
+ *     the switch and controller.
  *
- *   @return [EchoReply] 
- *     an object that encapsulates the +OFPT_ECHO_REPLY+ OpenFlow message.
+ * @raise [ArgumentError] if transaction ID is not an unsigned 32-bit integer.
+ * @raise [ArgumentError] if user data is not a string.
+ * @raise [TypeError] if argument is not a hash.
+ * @return [EchoReply]
  */
-static VALUE
-echo_reply_init( int argc, VALUE *argv, VALUE self ) {
-  buffer *echo_reply;
-  Data_Get_Struct( self, buffer, echo_reply );
-  uint32_t xid = get_transaction_id();
-  VALUE options;
-
-  if ( rb_scan_args( argc, argv, "01", &options ) == 1 ) {
-    Check_Type( options, T_HASH );
-    VALUE xid_ruby;
-    if ( ( xid_ruby = rb_hash_aref( options, ID2SYM( rb_intern( "transaction_id" ) ) ) ) != Qnil ) {
-      if ( rb_funcall( xid_ruby, rb_intern( "unsigned_32bit?" ), 0 ) == Qfalse ) {
-        rb_raise( rb_eArgError, "Transaction ID must be an unsigned 32-bit integer" );
-      }
-      xid = ( uint32_t ) NUM2UINT( xid_ruby );
-    }
-  }
-  ( ( struct ofp_header * ) ( echo_reply->data ) )->xid = htonl( xid );
-  return self;
-}
+VALUE
+echo_init( int argc, VALUE *argv, VALUE self ) {}
+#endif
 
 
+#if 0
 /*
- * Transaction ids, message sequence numbers matching requests to replies.
+ * Transaction ids, message sequence numbers matching requests to
+ * replies.
  *
  * @return [Number] the value of transaction id.
  */
-static VALUE
-echo_reply_transaction_id( VALUE self ) {
-  buffer *echo_reply;
-  Data_Get_Struct( self, buffer, echo_reply );
-  uint32_t xid = ntohl( ( ( struct ofp_header * ) ( echo_reply->data ) )->xid );
-  return UINT2NUM( xid );
-}
+VALUE
+echo_transaction_id( VALUE self ) {}
+#endif
+
+
+#if 0
+/*
+ * An arbitrary length user data payload.
+ *
+ * @return [String] a user data payload is set.
+ * @return [nil] a user data payload is not set.
+ */
+VALUE
+echo_user_data( VALUE self ) {}
+#endif
 
 
 void
 Init_echo_reply() {
   cEchoReply = rb_define_class_under( mTrema, "EchoReply", rb_cObject );
   rb_define_alloc_func( cEchoReply, echo_reply_alloc );
-  rb_define_method( cEchoReply, "initialize", echo_reply_init, -1 );
-  rb_define_method( cEchoReply, "transaction_id", echo_reply_transaction_id, 0 );
+  rb_define_method( cEchoReply, "initialize", echo_init, -1 );
+  rb_define_method( cEchoReply, "transaction_id", echo_transaction_id, 0 );
+  rb_alias( cEchoReply, rb_intern( "xid" ), rb_intern( "transaction_id" ) );
+  rb_define_method( cEchoReply, "user_data", echo_user_data, 0 );
 }
 
 

data/ruby/trema/echo-reply.h

@@ -1,6 +1,4 @@
 /*
- * Author: Nick Karanatsios <nickkaranatsios@gmail.com>
- *
  * Copyright (C) 2008-2012 NEC Corporation
  *
  * This program is free software; you can redistribute it and/or modify
@@ -39,4 +37,4 @@ void Init_echo_reply( void );
  * c-basic-offset: 2
  * indent-tabs-mode: nil
  * End:
- */
+ */

data/ruby/trema/echo-request.c

@@ -1,6 +1,4 @@
 /*
- * Author: Nick Karanatsios <nickkaranatsios@gmail.com>
- *
  * Copyright (C) 2008-2012 NEC Corporation
  *
  * This program is free software; you can redistribute it and/or modify
@@ -18,117 +16,97 @@
  */
 
 
-#include "trema.h"
+#include "echo.h"
 #include "ruby.h"
+#include "trema.h"
+#include "trema-ruby-utils.h"
 
 
 extern VALUE mTrema;
 VALUE cEchoRequest;
 
 
+static VALUE
+echo_request_alloc( VALUE klass ) {
+  return Data_Wrap_Struct( klass, NULL, free_buffer, create_echo_request( 0, NULL ) );
+}
+
+
+#if 0
 /*
- * An echo request message can be used to measure the bandwidth of a
- * controller/switch connection as well as to verify its liveness.
+ * Creates a EchoRequest OpenFlow message. This message can be used to
+ * measure the bandwidth of a controller/switch connection as well as
+ * to verify its liveness.
+ *
+ * @overload initialize()
+ *   @example
+ *     EchoRequest.new
+ *
+ * @overload initialize(transaction_id)
+ *   @example
+ *     EchoRequest.new( 123 )
+ *   @param [Integer] transaction_id
+ *     An unsigned 32bit integer number associated with this message.
  *
- * @overload initialize(options={})
+ * @overload initialize(options)
  *   @example
  *     EchoRequest.new(
  *       :transaction_id => transaction_id,
  *       :user_data => "Thu Aug 25 13:09:00 +0900 2011"
  *     )
- *
  *   @param [Hash] options
  *     the options to create a message with.
- *
+ *   @option options [Number] :xid
  *   @option options [Number] :transaction_id
- *     a positive number, not recently attached to any previous pending commands to
- *     guarantee message integrity auto-generated if not specified.
- *
+ *     An unsigned 32bit integer number associated with this message.
+ *     If not specified, an auto-generated value is set.
  *   @option options [String] :user_data
  *     the user data field specified as a String may be a message timestamp to check latency,
  *     various lengths to measure bandwidth or zero-size(nil) to verify liveness between
  *     the switch and controller.
  *
- *   @raise [ArgumentError] if transaction id is not an unsigned 32-bit integer.
- *   @raise [ArgumentError] if user data is not a string.
- *   @raise [TypeError] if options is not a hash.
- *
- *   @return [EchoRequest]
- *     an object that encapsulates the +OPFT_ECHO_REQUEST+ OpenFlow message.
+ * @raise [ArgumentError] if transaction ID is not an unsigned 32-bit integer.
+ * @raise [ArgumentError] if user data is not a string.
+ * @raise [TypeError] if argument is not a hash.
+ * @return [EchoRequest]
  */
-static VALUE
-echo_request_new( int argc, VALUE *argv, VALUE klass ) {
-  buffer *echo_request;
-  buffer *body = NULL;
-  uint32_t xid = get_transaction_id();
-  VALUE options;
-
-  if ( rb_scan_args( argc, argv, "01", &options ) == 1 ) {
-    Check_Type( options, T_HASH );
-    VALUE xid_ruby;
-    if ( ( xid_ruby = rb_hash_aref( options, ID2SYM( rb_intern( "transaction_id" ) ) ) ) != Qnil ) {
-      if ( rb_funcall( xid_ruby, rb_intern( "unsigned_32bit?" ), 0 ) == Qfalse ) {
-        rb_raise( rb_eArgError, "Transaction ID must be an unsigned 32-bit integer" );
-      }
-      xid = ( uint32_t ) NUM2UINT( xid_ruby );
-    }
-    VALUE user_data;
-    if ( ( user_data = rb_hash_aref( options, ID2SYM( rb_intern( "user_data" ) ) ) ) != Qnil ) {
-      if ( rb_obj_is_kind_of( user_data, rb_cString ) == Qfalse ) {
-        rb_raise( rb_eArgError, "User data must be a string" );
-      }
-      uint16_t length = ( u_int16_t ) RSTRING_LEN( user_data );
-      body = alloc_buffer_with_length( length );
-      void *p = append_back_buffer( body, length );
-      memcpy( p, RSTRING_PTR( user_data ), length );
-    }
-  }
-  echo_request = create_echo_request( xid, body );
-  if ( body != NULL ) {
-    free_buffer( body );
-  }
-  return Data_Wrap_Struct( klass, NULL, free_buffer, echo_request );
-}
+VALUE
+echo_init( int argc, VALUE *argv, VALUE self ) {}
+#endif
 
 
+#if 0
 /*
- * Transaction ids, message sequence numbers matching requests to replies.
+ * Transaction ids, message sequence numbers matching requests to
+ * replies.
  *
  * @return [Number] the value of transaction id.
  */
-static VALUE
-echo_request_transaction_id( VALUE self ) {
-  buffer *echo_request;
-  Data_Get_Struct( self, buffer, echo_request );
-  uint32_t xid = ntohl( ( ( struct ofp_header * ) ( echo_request->data ) )->xid );
-  return UINT2NUM( xid );
-}
+VALUE
+echo_transaction_id( VALUE self ) {}
+#endif
 
 
+#if 0
 /*
  * An arbitrary length user data payload.
  *
  * @return [String] a user data payload is set.
  * @return [nil] a user data payload is not set.
  */
-static VALUE
-echo_request_user_data( VALUE self ) {
-  buffer *echo_request;
-  Data_Get_Struct( self, buffer, echo_request );
-  if ( echo_request->length > sizeof( struct ofp_header ) ) {
-    return rb_str_new( ( char * ) echo_request->data + sizeof( struct ofp_header ),
-                       ( long ) ( echo_request->length - sizeof( struct ofp_header ) ) );
-  }
-  return Qnil;
-}
+VALUE
+echo_user_data( VALUE self ) {}
+#endif
 
 
 void
 Init_echo_request() {
   cEchoRequest = rb_define_class_under( mTrema, "EchoRequest", rb_cObject );
-  rb_define_singleton_method( cEchoRequest, "new", echo_request_new, -1 );
-  rb_define_method( cEchoRequest, "transaction_id", echo_request_transaction_id, 0 );
-  rb_define_method( cEchoRequest, "user_data", echo_request_user_data, 0 );
+  rb_define_alloc_func( cEchoRequest, echo_request_alloc );
+  rb_define_method( cEchoRequest, "initialize", echo_init, -1 );
+  rb_define_method( cEchoRequest, "transaction_id", echo_transaction_id, 0 );
+  rb_alias( cEchoRequest, rb_intern( "xid" ), rb_intern( "transaction_id" ) );
+  rb_define_method( cEchoRequest, "user_data", echo_user_data, 0 );
 }