trema 0.2.5 → 0.2.6

data/ruby/trema/shell/send_packets.rb

@@ -26,7 +26,7 @@ require "trema/dsl"
 module Trema
   module Shell
     def send_packets source, dest, options = {}
-      sanity_check
+      assert_trema_is_built
       Cli.new( Host[ source ] ).send_packets( Host[ dest ], options )
       true
     end

data/ruby/trema/shell/show_stats.rb

@@ -26,7 +26,7 @@ require "trema/dsl"
 module Trema
   module Shell
     def show_stats host_name, option
-      sanity_check
+      assert_trema_is_built
 
       raise "Host '#{ host_name }' is not defined." if Host[ host_name ].nil?
       raise "Host '#{ host_name }' is not connected to any link." if Host[ host_name ].interface.nil?

data/ruby/trema/stats-helper.rb

@@ -21,8 +21,8 @@
 module Trema
   class StatsHelper
 
-    
-    # Invoked by each StatsReply subclass to assign their instance attributes 
+
+    # Invoked by each StatsReply subclass to assign their instance attributes
     # to a value.
     #
     # @overload initialize(fields, options={})
@@ -41,7 +41,7 @@ module Trema
       end
     end
 
-    
+
     #
     # @return [String]
     #   an alphabetically sorted text of attribute name/value pairs.

data/ruby/trema/stats-reply.c

@@ -120,17 +120,17 @@ stats_reply_flags( VALUE self ) {
 /*
  * A list of reply type objects for this message.
  *
- * @return [Array<FlowStatsReply>] 
+ * @return [Array<FlowStatsReply>]
  *   an array of {FlowStatsReply} objects if type is +OFPST_FLOW+.
- * @return [Array<TableStatsReply>] 
+ * @return [Array<TableStatsReply>]
  *   an array of {TableStatsReply} objects if type is +OFPST_TABLE+.
- * @return [AggregateStatsReply] 
+ * @return [AggregateStatsReply]
  *   a {AggregateStatsReply} object if type is +OFPST_AGGREGATE+.
- * @return [Array<PortStatsReply>] 
+ * @return [Array<PortStatsReply>]
  *   an array of {PortStatsReply} objects if type is +OFPST_PORT+.
- * @return [Array<QueueStatsReply>] 
+ * @return [Array<QueueStatsReply>]
  *   an array of {QueueStatsReply} objects if type is +OFPST_QUEUE+.
- * @return [VendorStatsReply] 
+ * @return [VendorStatsReply]
  *   a {VendorStatsReply} object if type is +OFPST_VENDOR+.
  */
 static VALUE
@@ -149,6 +149,13 @@ Init_stats_reply() {
   rb_require( "trema/queue-stats-reply" );
   rb_require( "trema/vendor-stats-reply" );
   cStatsReply = rb_define_class_under( mTrema, "StatsReply", rb_cObject );
+  rb_define_const( cStatsReply, "OFPST_DESC", INT2NUM( OFPST_DESC ) );
+  rb_define_const( cStatsReply, "OFPST_FLOW", INT2NUM( OFPST_FLOW ) );
+  rb_define_const( cStatsReply, "OFPST_AGGREGATE", INT2NUM( OFPST_AGGREGATE ) );
+  rb_define_const( cStatsReply, "OFPST_TABLE", INT2NUM( OFPST_TABLE ) );
+  rb_define_const( cStatsReply, "OFPST_PORT", INT2NUM( OFPST_PORT ) );
+  rb_define_const( cStatsReply, "OFPST_QUEUE", INT2NUM( OFPST_QUEUE ) );
+  rb_define_const( cStatsReply, "OFPST_VENDOR", INT2NUM( OFPST_VENDOR ) );
   rb_define_method( cStatsReply, "initialize", stats_reply_init, 1 );
   rb_define_method( cStatsReply, "datapath_id", stats_reply_datapath_id, 0 );
   rb_define_method( cStatsReply, "transaction_id", stats_reply_transaction_id, 0 );
@@ -203,7 +210,8 @@ get_action( const struct ofp_action_header *ah ) {
       if ( ah->type == OFPAT_SET_DL_SRC ) {
         rb_hash_aset( options, ID2SYM( rb_intern( "dl_src" ) ),  dl_addr );
         action = rb_funcall( rb_eval_string( "Trema::ActionSetDlSrc" ), rb_intern( "new" ), 1, options );
-      } else {
+      }
+      else {
         rb_hash_aset( options, ID2SYM( rb_intern( "dl_dst" ) ),  dl_addr );
         action = rb_funcall( rb_eval_string( "Trema::ActionSetDlDst" ), rb_intern( "new" ), 1, options );
       }
@@ -219,7 +227,8 @@ get_action( const struct ofp_action_header *ah ) {
       if ( ah->type == OFPAT_SET_NW_SRC ) {
         rb_hash_aset( options, ID2SYM( rb_intern( "nw_src" ) ), nw_addr );
         action = rb_funcall( rb_eval_string( "Trema::ActionSetNwSrc" ), rb_intern( "new" ), 1, options );
-      } else {
+      }
+      else {
         rb_hash_aset( options, ID2SYM( rb_intern( "nw_dst" ) ), nw_addr );
         action = rb_funcall( rb_eval_string( "Trema::ActionSetNwDst" ), rb_intern( "new" ), 1, options );
       }
@@ -305,15 +314,15 @@ handle_stats_reply(
       VALUE desc_stats_arr = rb_ary_new();
       VALUE desc_stats_reply;
 
-      rb_hash_aset( options, ID2SYM( rb_intern( "mfr_desc" ) ), 
+      rb_hash_aset( options, ID2SYM( rb_intern( "mfr_desc" ) ),
         rb_str_new( desc_stats->mfr_desc, ( long ) strnlen( desc_stats->mfr_desc, DESC_STR_LEN - 1 ) ) );
-      rb_hash_aset( options, ID2SYM( rb_intern( "hw_desc" ) ), 
+      rb_hash_aset( options, ID2SYM( rb_intern( "hw_desc" ) ),
         rb_str_new( desc_stats->hw_desc, ( long ) strnlen( desc_stats->hw_desc, DESC_STR_LEN  - 1 ) ) );
-      rb_hash_aset( options, ID2SYM( rb_intern( "sw_desc" ) ), 
+      rb_hash_aset( options, ID2SYM( rb_intern( "sw_desc" ) ),
         rb_str_new( desc_stats->sw_desc, ( long ) strnlen( desc_stats->sw_desc, DESC_STR_LEN  - 1 ) ) );
-      rb_hash_aset( options, ID2SYM( rb_intern( "serial_num" ) ), 
+      rb_hash_aset( options, ID2SYM( rb_intern( "serial_num" ) ),
         rb_str_new( desc_stats->serial_num, ( long ) strnlen( desc_stats->serial_num, SERIAL_NUM_LEN  - 1 ) ) );
-      rb_hash_aset( options, ID2SYM( rb_intern( "dp_desc" ) ), 
+      rb_hash_aset( options, ID2SYM( rb_intern( "dp_desc" ) ),
         rb_str_new( desc_stats->dp_desc, ( long ) strnlen( desc_stats->dp_desc, DESC_STR_LEN  - 1 ) ) );
       desc_stats_reply = rb_funcall( rb_eval_string( " Trema::DescStatsReply" ), rb_intern( "new" ), 1, options );
       rb_ary_push( desc_stats_arr, desc_stats_reply );
@@ -363,7 +372,7 @@ handle_stats_reply(
         flow_stats_reply = rb_funcall( rb_eval_string( "Trema::FlowStatsReply" ), rb_intern( "new" ), 1, options );
         rb_ary_push( flow_stats_arr, flow_stats_reply );
 
-        // here create flow_stats object and insert into array 
+        // here create flow_stats object and insert into array
         body_length = ( uint16_t ) ( body_length - flow_stats->length );
 
         if ( body_length ) {
@@ -410,7 +419,7 @@ handle_stats_reply(
         table_stats_reply = rb_funcall( rb_eval_string( "Trema::TableStatsReply" ), rb_intern( "new" ), 1, options );
 
         rb_ary_push( table_stats_arr, table_stats_reply );
-        body_length = ( uint16_t ) ( body_length - sizeof ( struct ofp_table_stats ) );
+        body_length = ( uint16_t ) ( body_length - sizeof( struct ofp_table_stats ) );
         if ( body_length ) {
           table_stats++;
         }
@@ -444,7 +453,7 @@ handle_stats_reply(
         port_stats_reply = rb_funcall( rb_eval_string( "Trema::PortStatsReply" ), rb_intern( "new" ), 1, options );
 
         rb_ary_push( port_stats_arr, port_stats_reply );
-        body_length = ( uint16_t ) ( body_length - sizeof ( struct ofp_port_stats ) );
+        body_length = ( uint16_t ) ( body_length - sizeof( struct ofp_port_stats ) );
         if ( body_length ) {
           port_stats++;
         }
@@ -467,7 +476,7 @@ handle_stats_reply(
         queue_stats_reply = rb_funcall( rb_eval_string( "Trema::QueueStatsReply" ), rb_intern( "new" ), 1, options );
 
         rb_ary_push( queue_stats_arr, queue_stats_reply );
-        body_length = ( uint16_t ) ( body_length - sizeof ( struct ofp_queue_stats ) );
+        body_length = ( uint16_t ) ( body_length - sizeof( struct ofp_queue_stats ) );
         if ( body_length ) {
           queue_stats++;
         }

data/ruby/trema/stats-request.c

@@ -74,7 +74,7 @@ static const uint8_t  TABLE_ID = 0xff;
  *
  *   @raise [ArgumentError] if supplied transaction_id is not an unsigned 32-bit integer.
  *
- *   @return [StatsRequest] 
+ *   @return [StatsRequest]
  *     an object that encapsulates an +OFPT_STATS_REQUEST+ OpenFlow message.
  */
 static VALUE
@@ -127,7 +127,7 @@ desc_stats_request_alloc( VALUE klass ) {
 }
 
 
-static VALUE 
+static VALUE
 flow_stats_request_alloc( VALUE klass ) {
   buffer *flow_stats_request = create_flow_stats_request( MY_TRANSACTION_ID, NO_FLAGS, MATCH, TABLE_ID, OUT_PORT );
   return Data_Wrap_Struct( klass, NULL, free_buffer, flow_stats_request );
@@ -234,7 +234,7 @@ stats_out_port( VALUE self ) {
 /*
  * Restrict port statistics to a specific port_no or to all ports.
  *
-  @return [Number] the value of port_no.
+ * @return [Number] the value of port_no.
  */
 static VALUE
 stats_port_no( VALUE self ) {
@@ -285,7 +285,7 @@ get_stats_request_table_id( VALUE self ) {
 static VALUE
 parse_common_arguments( int argc, VALUE *argv, VALUE self ) {
   VALUE options;
-  if ( !rb_scan_args( argc, argv, "01", &options )) {
+  if ( !rb_scan_args( argc, argv, "01", &options ) ) {
     options = rb_hash_new();
   }
   rb_call_super( 1, &options );
@@ -300,15 +300,15 @@ parse_common_arguments( int argc, VALUE *argv, VALUE self ) {
 
 
 /*
- * A {DescStatsRequest} object instance to request descriptive information of vswitch.
- * Such information includes switch manufacturer, hardware revision and serial number
+ * A {DescStatsRequest} object instance to request descriptive information of
+ * OpenFlow switch. Such information includes switch manufacturer, hardware
+ * revision and serial number
  *
  * @overload initialize(options={})
  *
- *   @example 
- *     DescStatsRequest.new(
- *       :transaction_id => 1234
- *     )
+ *   @example
+ *     DescStatsRequest.new
+ *     DescStatsRequest.new( :transaction_id => 1234 )
  *
  *   @param [Hash] options
  *     the options to create a message with.
@@ -316,8 +316,8 @@ parse_common_arguments( int argc, VALUE *argv, VALUE self ) {
  *   @option options [Number] :transaction_id
  *     set the transaction_id as specified or auto-generate it.
  *
- *   @return [TableStatsRequest]
- *     an object that encapsulates the +OFPT_STATS_REQUEST(OFPST_DSST)+ openflow
+ *   @return [DescStatsRequest]
+ *     an object that encapsulates the +OFPT_STATS_REQUEST(OFPST_DESC)+ OpenFlow
  *     message.
  */
 static VALUE
@@ -331,9 +331,9 @@ desc_stats_request_init( int argc, VALUE *argv, VALUE self ) {
  *
  * @overload initialize(options={})
  *   @example
- *     FlowStatsRequest.new(
- *       :match => Match
- *     )
+ *     FlowStatsRequest.new( :match => Match )
+ *     FlowStatsRequest.new( :match => Match, :table_id => 1 )
+ *     FlowStatsRequest.new( :match => Match, :table_id => 1, :out_port => 2 )
  *
  *   @param [Hash] options
  *     the options to create a message with.
@@ -350,7 +350,8 @@ desc_stats_request_init( int argc, VALUE *argv, VALUE self ) {
  *     a value of +OFPP_NONE+ would match all flow entries and is set to if not
  *     specified.
  *
- *   @raise [ArgumentError] if option[:match] is not specified.
+ *   @raise [ArgumentError] if option match is not specified.
+ *   @raise [TypeError] if option match is not a Trema::Match object.
  *
  *   @return [FlowStatsRequest]
  *     an object that encapsulates the +OFPT_STATS_REQUEST(OFPST_FLOW)+ OpenFlow message.
@@ -384,9 +385,8 @@ flow_stats_request_init( VALUE self, VALUE options ) {
  * A {AggregateStatsRequest} object instance to request aggregate statistics.
  * @overload initialize(options={})
  *   @example
- *     AggregateStatsRequest.new(
- *       :match => Match
- *     )
+ *     AggregateStatsRequest.new( :match => Match )
+ *     AggregateStatsRequest.new( :match => Match, :table_id => 1, :out_port => 2 )
  *
  *   @param [Hash] options
  *     the options to create a message with.
@@ -403,7 +403,8 @@ flow_stats_request_init( VALUE self, VALUE options ) {
  *     a value of +OFPP_NONE+ would match all flow entries and is set to if not
  *     specified.
  *
- *   @raise [ArgumentError] if option[:match] is not specified.
+ *   @raise [ArgumentError] if option match is not specified.
+ *   @raise [TypeError] if option match is not a Trema::Match object.
  *
  *   @return [AggregateStatsRequest]
  *     an object that encapsulates the +OFPT_STATS_REQUEST(OFPST_AGGREGATE)+ OpenFlow message.
@@ -440,10 +441,9 @@ aggregate_stats_request_init( VALUE self, VALUE options ) {
  *
  * @overload initialize(options={})
  *
- *   @example 
- *     TableStatsRequest.new(
- *       :transaction_id => 1234
- *     )
+ *   @example
+ *     TableStatsRequest.new
+ *     TableStatsRequest.new( :transaction_id => 1234 )
  *
  *   @param [Hash] options
  *     the options to create a message with.
@@ -452,7 +452,7 @@ aggregate_stats_request_init( VALUE self, VALUE options ) {
  *     set the transaction_id as specified or auto-generate it.
  *
  *   @return [TableStatsRequest]
- *     an object that encapsulates the +OFPT_STATS_REQUEST(OFPST_TABLE)+ openflow
+ *     an object that encapsulates the +OFPT_STATS_REQUEST(OFPST_TABLE)+ OpenFlow
  *     message.
  */
 static VALUE
@@ -468,9 +468,8 @@ table_stats_request_init( int argc, VALUE *argv, VALUE self ) {
  * @overload initialize(options={})
  *
  *   @example
- *     PortStatsRequest.new(
- *       :port_no => port_no
- *     )
+ *     PortStatsRequest.new
+ *     PortStatsRequest.new( :port_no => 1 )
  *
  *   @param [Hash] options
  *     the options to create a message with.
@@ -480,13 +479,13 @@ table_stats_request_init( int argc, VALUE *argv, VALUE self ) {
  *     to +OFPP_NONE+ for all ports.
  *
  *   @return [PortStatsRequest]
- *     an object that encapsulates the +OFPT_STATS_REQUEST(OFPST_PORT)+ OpenFlow 
+ *     an object that encapsulates the +OFPT_STATS_REQUEST(OFPST_PORT)+ OpenFlow
  *     message.
  */
 static VALUE
 port_stats_request_init( int argc, VALUE *argv, VALUE self ) {
   VALUE options;
-  if ( !rb_scan_args( argc, argv, "01", &options )) {
+  if ( !rb_scan_args( argc, argv, "01", &options ) ) {
     options = rb_hash_new();
   }
   rb_call_super( 1, &options );
@@ -515,10 +514,10 @@ port_stats_request_init( int argc, VALUE *argv, VALUE self ) {
  * @overload initialize(options={})
  *
  *   @example
- *     QueueStatsRequest.new(
- *       :port_no => port_no,
- *       :queue_id => queue_id
- *     )
+ *     QueueStatsRequest.new
+ *     QueueStatsRequest.new( :port_no => 1, :queue_id => 123 )
+ *     QueueStatsRequest.new( :port_no => 1 )
+ *     QueueStatsRequest.new( :queue_id => 123 )
  *
  *   @param [Hash] options
  *     the options to create a message with.
@@ -538,7 +537,7 @@ port_stats_request_init( int argc, VALUE *argv, VALUE self ) {
 static VALUE
 queue_stats_request_init( int argc, VALUE *argv, VALUE self ) {
   VALUE options;
-  if ( !rb_scan_args( argc, argv, "01", &options )) {
+  if ( !rb_scan_args( argc, argv, "01", &options ) ) {
     options = rb_hash_new();
   }
   rb_call_super( 1, &options );
@@ -577,9 +576,8 @@ queue_stats_request_init( int argc, VALUE *argv, VALUE self ) {
  * @overload initialize(options={})
  *
  *   @example
- *     VendorStatsRequeset.new(
- *       :vendor_id => vendor_id
- *     )
+ *     VendorStatsRequest.new
+ *     VendorStatsRequest.new( :vendor_id => 123 )
  *
  *   @param [Hash] options
  *     the options to create a message with.
@@ -589,14 +587,14 @@ queue_stats_request_init( int argc, VALUE *argv, VALUE self ) {
  *     to a default value of 0x00004cff.
  *
  *   @return [VendorStatsRequest]
- *     an object that encapsulates the +OFPT_STATS_REQUEST(OFPST_VENDOR)+ openflow
+ *     an object that encapsulates the +OFPT_STATS_REQUEST(OFPST_VENDOR)+ OpenFlow
  *     message.
  */
 static VALUE
 vendor_stats_request_init( int argc, VALUE *argv, VALUE self ) {
   VALUE options;
 
-  if ( !rb_scan_args( argc, argv, "01", &options )) {
+  if ( !rb_scan_args( argc, argv, "01", &options ) ) {
     options = rb_hash_new();
   }
   rb_call_super( 1, &options );
@@ -619,7 +617,7 @@ vendor_stats_request_init( int argc, VALUE *argv, VALUE self ) {
 
 
 void
-Init_stats_request(){
+Init_stats_request() {
   cStatsRequest = rb_define_class_under( mTrema, "StatsRequest", rb_cObject );
 
   cDescStatsRequest = rb_define_class_under( mTrema, "DescStatsRequest", cStatsRequest );

data/ruby/trema/switch-daemon.rb

@@ -20,14 +20,37 @@
 
 module Trema
   class SwitchDaemon
+    MANDATORY_QUEUES = [ :port_status, :packet_in, :state_notify ]
+
+
+    #
+    # Creates a new abstract representation of SwitchDaemon instance
+    # by accepting and validating a hash of queue options.
+    #
+    # @param [Hash] queues a hash of queue arguments to assign.
+    # @option queues [Symbol] :port_status
+    #   the controller(s) to receive port status messages.
+    # @option queues [Symbol] :packet_in
+    #   the controller(s) to receive packet_in messages.
+    # @option queues [Symbol] :state_notify
+    #   the controller(s) to receive state notification messages.
+    #
     def initialize queues
       check_mandatory_options queues
       @queues = queues
     end
 
 
+    #
+    # Constructs switch daemon's options associating one or more controller
+    # name to a queue name.
+    #
+    # @return [Array<String>] the switch daemon's options.
     def options
-      portstatus_queue + packetin_queue + statenotify_queue + vendor_queue
+      all_queues = MANDATORY_QUEUES + [ :vendor ]
+      all_queues.collect! do | each |
+        queue each
+      end.flatten!
     end
 
 
@@ -36,42 +59,24 @@ module Trema
     ################################################################################
 
 
+    #
+    # @raise [RuntimeError] if a mandatory option is not found.
+    #
     def check_mandatory_options queues
-      [ :port_status, :packet_in, :state_notify ].each do | each |
+      MANDATORY_QUEUES.each do | each |
         raise ":#{ each } is a mandatory option" if queues[ each ].nil?
       end
     end
 
 
-    def portstatus_queue
-      controllers = @queues[ :port_status ].split( "," )
-      controllers.collect do | each |
-        "port_status::#{ each }"
-      end
-    end
-
-
-    def packetin_queue
-      controllers = @queues[ :packet_in ].split( "," )
-      controllers.collect do | each |
-        "packet_in::#{ each }"
-      end
-    end
-
-
-    def statenotify_queue
-      controllers = @queues[ :state_notify ].split( "," )
-      controllers.collect do | each |
-        "state_notify::#{ each }"
-      end
-    end
-
-
-    def vendor_queue
-      return [] if not @queues[ :vendor ]
-      controllers = @queues[ :vendor ].split( "," )
-      controllers.collect do | each |
-        "vendor::#{ each }"
+    #
+    # @return [Array<String>] an array of controller name strings.
+    #
+    def queue queue_type
+      return [] unless @queues[ queue_type ]
+      controllers = @queues[ queue_type ].split( "," )
+      controllers.collect! do | each |
+        "#{ queue_type.to_s }::#{ each }"
       end
     end
   end