trema 0.2.5 → 0.2.6

data/ruby/trema/echo-reply.h

@@ -17,7 +17,7 @@
 
 
 #ifndef ECHO_REPLY_H
-#define	ECHO_REPLY_H
+#define ECHO_REPLY_H
 
 
 #include "ruby.h"
@@ -29,7 +29,7 @@ extern VALUE cEchoReply;
 void Init_echo_reply( void );
 
 
-#endif	// ECHO_REPLY_H
+#endif // ECHO_REPLY_H
 
 
 /*

data/ruby/trema/echo-request.c

@@ -17,8 +17,6 @@
 
 
 #include "echo.h"
-#include "ruby.h"
-#include "trema.h"
 #include "trema-ruby-utils.h"
 
 
@@ -46,7 +44,7 @@ echo_request_alloc( VALUE klass ) {
  *   @example
  *     EchoRequest.new( 123 )
  *   @param [Integer] transaction_id
- *     An unsigned 32bit integer number associated with this message.
+ *     An unsigned 32-bit integer number associated with this message.
  *
  * @overload initialize(options)
  *   @example
@@ -56,9 +54,9 @@ echo_request_alloc( VALUE klass ) {
  *     )
  *   @param [Hash] options
  *     the options to create a message with.
- *   @option options [Number] :xid
+ *   @option options [Number] :xid an alias to transaction_id.
  *   @option options [Number] :transaction_id
- *     An unsigned 32bit integer number associated with this message.
+ *     An unsigned 32-bit 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,

data/ruby/trema/enqueue.rb

@@ -60,13 +60,13 @@ module Trema
         if @port_number.nil?
           raise ArgumentError, "Port number is a mandatory option"
         end
-        if not @port_number.unsigned_16bit?
+        unless @port_number.unsigned_16bit?
           raise ArgumentError, "Port number must be an unsigned 16-bit integer"
         end
         if @queue_id.nil?
           raise ArgumentError, "Queue ID is a mandatory option"
         end
-        if not @queue_id.unsigned_32bit?
+        unless @queue_id.unsigned_32bit?
           raise ArgumentError, "Queue ID must be an unsigned 32-bit integer"
         end
       else

data/ruby/trema/error.c

@@ -234,9 +234,9 @@ Init_error() {
   rb_define_const( mTrema, "OFPPMFC_BAD_HW_ADDR", INT2NUM( OFPPMFC_BAD_HW_ADDR ) );
 
   rb_define_const( mTrema, "OFPET_QUEUE_OP_FAILED", INT2NUM( OFPET_QUEUE_OP_FAILED ) );
-  rb_define_const( mTrema, "OFPQOFC_BAD_PORT", INT2NUM(OFPQOFC_BAD_PORT));
-  rb_define_const( mTrema, "OFPQOFC_BAD_QUEUE", INT2NUM(OFPQOFC_BAD_QUEUE));
-  rb_define_const( mTrema, "OFPQOFC_EPERM", INT2NUM(OFPQOFC_EPERM));
+  rb_define_const( mTrema, "OFPQOFC_BAD_PORT", INT2NUM( OFPQOFC_BAD_PORT ) );
+  rb_define_const( mTrema, "OFPQOFC_BAD_QUEUE", INT2NUM( OFPQOFC_BAD_QUEUE ) );
+  rb_define_const( mTrema, "OFPQOFC_EPERM", INT2NUM( OFPQOFC_EPERM ) );
 
   cError = rb_define_class_under( mTrema, "Error", rb_cObject );
 

data/ruby/trema/executables.rb

@@ -24,13 +24,21 @@ require "trema/path"
 
 
 #
-# Holds the list of executalbes found in {Trema.objects} directory.
+# Holds a list of executables found in Trema.objects directory.
 #
 class Trema::Executables
   class << self
+    #
+    # Cycles through a list of file names testing if there are executable or
+    # not.
+    #
+    # @return [FalseClass, Array]
+    #   false if a file name is not an executable program or a list of all
+    #   file names that are.
+    #
     def compiled?
       @list.each do | each |
-        return false if not FileTest.executable?( __send__ each )
+        return false unless FileTest.executable?( __send__ each )
       end
     end
 
@@ -40,12 +48,28 @@ class Trema::Executables
     ############################################################################
 
 
+    #
+    # Adds the name to a list.
+    #
     def add name
       @list ||= []
       @list << name
     end
 
 
+    #
+    # Defines a class method that returns the full path name of an executable
+    # program constructed from its relative path. It also adds the
+    # class method name to an array.
+    #
+    # @example
+    #   path "openvswitch/bin/ovs-ofctl"
+    #
+    # @param [String] path
+    #   the relative path to an executable program.
+    #
+    # @return [Array] a list of a class method to access each executable program.
+    #
     def path path
       name = File.basename( path ).underscore
       define_class_method( name ) do

data/ruby/trema/features-request.c

@@ -16,9 +16,7 @@
  */
 
 
-#include "ruby.h"
 #include "trema-ruby-utils.h"
-#include "trema.h"
 
 
 extern VALUE mTrema;
@@ -43,7 +41,7 @@ features_request_alloc( VALUE klass ) {
  *   @example
  *     FeaturesRequest.new( 123 )
  *   @param [Integer] transaction_id
- *     An unsigned 32bit integer number associated with this message.
+ *     An unsigned 32-bit integer number associated with this message.
  *
  * @overload initialize(options)
  *   @example
@@ -51,9 +49,9 @@ features_request_alloc( VALUE klass ) {
  *     FeaturesRequest.new( :transaction_id => 123 )
  *   @param [Hash] options
  *     the options to create a message with.
- *   @option options [Number] :xid
+ *   @option options [Number] :xid an alias to transaction_id.
  *   @option options [Number] :transaction_id
- *     An unsigned 32bit integer number associated with this message.
+ *     An unsigned 32-bit integer number associated with this message.
  *     If not specified, an auto-generated value is set.
  *
  * @raise [ArgumentError] if transaction ID is not an unsigned 32-bit integer.

data/ruby/trema/flow-removed.c

@@ -34,8 +34,8 @@ VALUE cFlowRemoved;
  * Returns an object that encapsulates the +OPPT_FLOW_REMOVED+ OpenFlow message.
  *
  * @overload initialize(options={})
- *   @example 
- *     FlowRemoved.new( 
+ *   @example
+ *     FlowRemoved.new(
  *       :datapath_id => 0xabc,
  *       :transaction_id => 0,
  *       :match => Match,
@@ -59,15 +59,15 @@ VALUE cFlowRemoved;
  *     unsolicited message transaction_id is zero.
  *
  *   @option options [Symbol] :match
- *     a {Match} object describing the flow fields copied from the corresponding 
+ *     a {Match} object describing the flow fields copied from the corresponding
  *     flow setup message.
  *
  *   @option options [Symbol] :cookie
- *     an opaque handle copied from the corresponding 
+ *     an opaque handle copied from the corresponding
  *     flow setup message.
  *
  *   @option options [Symbol] :priority
- *     the priority level of the flow copied from the corresponding 
+ *     the priority level of the flow copied from the corresponding
  *     flow setup message.
  *
  *   @option options [Symbol] :reason
@@ -80,7 +80,7 @@ VALUE cFlowRemoved;
  *     the number of nanoseconds the flow was active.
  *
  *   @option options [Symbol] :idle_timeout
- *     time elapsed in seconds before the flow is removed, copied from the 
+ *     time elapsed in seconds before the flow is removed, copied from the
  *     corresponding flow setup message.
  *
  *   @option options [Symbol] :packet_count

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

@@ -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
@@ -27,7 +25,7 @@ module Trema
       %w(priority idle_timeout hard_timeout cookie packet_count byte_count actions)
     FIELDS.each { |field| attr_reader field.intern }
 
-    
+
     # Flow counters for one or more matched flows.
     # A user would not explicitly instantiate a {FlowStatsReply} object but
     # would be created as a result of parsing the +OFPT_STATS_REPLY(OFPST_FLOW)+
@@ -35,10 +33,10 @@ module Trema
     #
     # @overload initialize(options={})
     #
-    #   @example 
+    #   @example
     #     FlowStatsReply.new(
     #       :length => 96,
-    #       :table_id => 0, 
+    #       :table_id => 0,
     #       :match => Match.new
     #       :duration_sec => 10,
     #       :duration_nsec => 106000000,
@@ -77,7 +75,7 @@ module Trema
     #     no deletion.
     #
     #   @option options [Number] :hard_timeout
-    #     a fixed time interval before the flow is deleted. Zero means no 
+    #     a fixed time interval before the flow is deleted. Zero means no
     #     deletion.
     #
     #   @option options [Number] :cookie
@@ -93,9 +91,9 @@ module Trema
     #     an array of action objects for the flow.
     #
     #   @return [FlowStatsReply]
-    #     an object that encapsulates the OFPST_STATS_REPLY(OPPST_FLOW) OpenFlow message.
+    #     an object that encapsulates the OFPST_STATS_REPLY(OFPST_FLOW) OpenFlow message.
     #
-    def initialize options 
+    def initialize options
       super FIELDS, options
     end
   end

data/ruby/trema/flow.rb

@@ -20,9 +20,19 @@
 
 module Trema
   class Flow
-    attr_reader :dl_type
 
 
+    #
+    # Parses a text line of OpenFlow switch's dump-flows command into a Flow
+    # object's dynamic created attributes. A line consists of multiple
+    # comma separated key=value fields. A key field may have multiple values
+    # specified as key=value#1,value#2,..value#n.
+    #
+    # @param [String] line the text line to parse.
+    #
+    # @return [self] the object that holds the parsed key=value fields
+    #   as attributes.
+    #
     def self.parse line
       flow = self.new
       # to simplify parsing
@@ -41,6 +51,7 @@ module Trema
     end
 
 
+    # @return [Boolean] whether a flow is a user registered flow or not.
     def users_flow?
       not ( ( @actions == "drop" and @priority == 0 ) or
             @actions == "CONTROLLER:65535" )

data/ruby/trema/get-config-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,8 +16,7 @@
  */
 
 
-#include "trema.h"
-#include "ruby.h"
+#include "trema-ruby-utils.h"
 
 
 extern VALUE mTrema;
@@ -34,44 +31,77 @@ get_config_request_alloc( VALUE klass ) {
 
 
 /*
- * Creates a {GetConfigRequest} instance to query configuration parameters 
+ * Creates a {GetConfigRequest} instance to query configuration parameters
  * from the switch.
  *
- * @overload initialize(options={})
+ * @overload initialize()
  *   @example
  *     GetConfigRequest.new
- *     GetConfigRequest.new( :transaction_id => 123 )
  *
+ * @overload initialize(transaction_id)
+ *   @example
+ *     GetConfigRequest.new( 123 )
+ *   @param [Integer] transaction_id
+ *     An unsigned 32-bit integer number associated with this message.
+ *
+ * @overload initialize(options)
+ *   @example
+ *     GetConfigRequest.new( :xid => 123 )
+ *     GetConfigRequest.new( :transaction_id => 123 )
  *   @param [Hash] options
  *     the options to create a message with.
- *
+ *   @option options [Number] :xid an alias to transaction_id.
  *   @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 32-bit integer number associated with this message.
+ *     If not specified, an auto-generated value is set.
  *
- *   @return [GetConfigRequest]
+ * @raise [ArgumentError] if transaction ID is not an unsigned 32-bit integer.
+ * @raise [TypeError] if argument is not a Integer or a Hash.
+ * @return [GetConfigRequest]
  *     an object that encapsulates the +OFPT_GET_CONFIG+ OpenFlow message.
  */
 static VALUE
 get_config_request_init( int argc, VALUE *argv, VALUE self ) {
   buffer *get_config_request;
   Data_Get_Struct( self, buffer, get_config_request );
-  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" );
+  VALUE options = Qnil;
+
+
+  if ( rb_scan_args( argc, argv, "01", &options ) == 0 ) {
+    set_xid( get_config_request, get_transaction_id() );
+  }
+  else {
+    if ( options == Qnil ) {
+      set_xid( get_config_request, get_transaction_id() );
+    }
+    else if ( rb_obj_is_kind_of( options, rb_cInteger ) == Qtrue ) {
+      validate_xid( options );
+      set_xid( get_config_request, ( uint32_t ) NUM2UINT( options ) );
+    }
+    else {
+      Check_Type( options, T_HASH );
+      VALUE tmp = Qnil;
+      VALUE xid = Qnil;
+
+      tmp = rb_hash_aref( options, ID2SYM( rb_intern( "transaction_id" ) ) );
+      if ( tmp != Qnil ) {
+        xid = tmp;
+      }
+      tmp = rb_hash_aref( options, ID2SYM( rb_intern( "xid" ) ) );
+      if ( tmp != Qnil ) {
+        xid = tmp;
+      }
+
+      if ( xid != Qnil ) {
+        validate_xid( xid );
+        set_xid( get_config_request, ( uint32_t ) NUM2UINT( xid ) );
+      }
+      else {
+        set_xid( get_config_request, get_transaction_id() );
       }
-      xid = ( uint32_t ) NUM2UINT( xid_ruby );
     }
   }
-  ( ( struct ofp_header * ) ( get_config_request->data ) )->xid = htonl( xid );
+
   return self;
 }
 
@@ -83,10 +113,7 @@ get_config_request_init( int argc, VALUE *argv, VALUE self ) {
  */
 static VALUE
 get_config_request_transaction_id( VALUE self ) {
-  buffer *get_config_request;
-  Data_Get_Struct( self, buffer, get_config_request );
-  uint32_t xid = ntohl( ( ( struct ofp_header * ) ( get_config_request->data ) )->xid );
-  return UINT2NUM( xid );
+  return get_xid( self );
 }
 
 

data/ruby/trema/hello.c

@@ -16,8 +16,6 @@
  */
 
 
-#include "ruby.h"
-#include "trema.h"
 #include "trema-ruby-utils.h"
 
 
@@ -43,7 +41,7 @@ hello_alloc( VALUE klass ) {
  *   @example
  *     Hello.new( 123 )
  *   @param [Integer] transaction_id
- *     An unsigned 32bit integer number associated with this message.
+ *     An unsigned 32-bit integer number associated with this message.
  *
  * @overload initialize(options)
  *   @example
@@ -51,9 +49,9 @@ hello_alloc( VALUE klass ) {
  *     Hello.new( :transaction_id => 123 )
  *   @param [Hash] options
  *     the options to create a message with.
- *   @option options [Number] :xid
+ *   @option options [Number] :xid an alias to transaction_id.
  *   @option options [Number] :transaction_id
- *     An unsigned 32bit integer number associated with this message.
+ *     An unsigned 32-bit integer number associated with this message.
  *     If not specified, an auto-generated value is set.
  *
  * @raise [ArgumentError] if transaction ID is not an unsigned 32-bit integer.

data/ruby/trema/host.rb

@@ -206,6 +206,14 @@ module Trema
     end
 
 
+    #
+    # Check stats type and delegate processing.
+    #
+    # @raise [RuntimeError] if stats type is invalid.
+    #
+    # @return [Stat]
+    #   the object that represents the results of a particular stats type.
+    #
     def stats type
       case type
       when :tx