trema 0.2.2.1 → 0.2.3

data/ruby/trema/{action-output.h → flow-mod.h}

@@ -1,5 +1,5 @@
 /*
- * Author: Yasuhito Takamiya <yasuhito@gmail.com>
+ * Ruby wrapper class of OpenFlow FlowMod message.
  *
  * Copyright (C) 2008-2012 NEC Corporation
  *
@@ -18,20 +18,20 @@
  */
 
 
-#ifndef ACTION_OUTPUT_H
-#define ACTION_OUTPUT_H
+#ifndef RUBY_FLOW_MOD_H
+#define RUBY_FLOW_MOD_H
 
 
 #include "ruby.h"
 
 
-extern VALUE cActionOutput;
+extern VALUE cFlowMod;
 
 
-void Init_action_output( void );
+void Init_flow_mod( void );
 
 
-#endif // ACTION_OUTPUT_H
+#endif // RUBY_FLOW_MOD_H
 
 
 /*

data/ruby/trema/get-config-request.c

@@ -96,6 +96,7 @@ Init_get_config_request() {
   rb_define_alloc_func( cGetConfigRequest, get_config_request_alloc );
   rb_define_method( cGetConfigRequest, "initialize", get_config_request_init, -1 );
   rb_define_method( cGetConfigRequest, "transaction_id", get_config_request_transaction_id, 0 );
+  rb_alias( cGetConfigRequest, rb_intern( "xid" ), rb_intern( "transaction_id" ) );
 }
 
 

data/ruby/trema/hardware-switch.rb

@@ -0,0 +1,88 @@
+#
+# 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 "trema/openflow-switch"
+
+
+module Trema
+  #
+  # Hardware switch that supports OpenFlow protocol.
+  #
+  class HardwareSwitch
+    #
+    # The name of this switch
+    #
+    # @example
+    #   switch.name #=> "My expensive OpenFlow switch"
+    #
+    # @return [String]
+    #
+    attr_reader :name
+
+
+    #
+    # Creates a new HardwareSwitch from {DSL::Switch}
+    #
+    # @example
+    #   switch = Trema::HardwareSwitch.new( stanza )
+    #
+    # @return [HardwareSwitch]
+    #
+    def initialize stanza
+      stanza.validate
+      @name = stanza.name
+      @stanza = stanza
+      OpenflowSwitch.add self
+    end
+
+
+    #
+    # Returns datapath id in long format
+    #
+    # @example
+    #   switch.dpid_long #=> "0000000000000abc"
+    #
+    # @return [String]
+    #
+    def dpid_long
+      @stanza.fetch :dpid_long
+    end
+
+
+    #
+    # Returns datapath id prefixed with "0x"
+    #
+    # @example
+    #   switch.dpid_short #=> "0xabc"
+    #
+    # @return [String]
+    #
+    def dpid_short
+      @stanza.fetch :dpid_short
+    end
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/ruby/trema/hello.c

@@ -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
@@ -18,8 +16,9 @@
  */
 
 
-#include "trema.h"
 #include "ruby.h"
+#include "trema.h"
+#include "trema-ruby-utils.h"
 
 
 extern VALUE mTrema;
@@ -36,60 +35,84 @@ hello_alloc( VALUE klass ) {
 /*
  * Creates a Hello OpenFlow message.
  *
- * @overload initialize(options={})
- *
+ * @overload initialize()
  *   @example
  *     Hello.new
- *     Hello.new( :transaction_id => 123 )
  *
+ * @overload initialize(transaction_id)
+ *   @example
+ *     Hello.new( 123 )
+ *   @param [Integer] transaction_id
+ *     An unsigned 32bit integer number associated with this message.
+ *
+ * @overload initialize(options)
+ *   @example
+ *     Hello.new( :xid => 123 )
+ *     Hello.new( :transaction_id => 123 )
  *   @param [Hash] options
  *     the options to create a message with.
- *
+ *   @option options [Number] :xid
  *   @option options [Number] :transaction_id
  *     An unsigned 32bit 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.
- *   @raise [TypeError] if options is not a Hash.
- *
- *   @return [Hello]
- *     an object that encapsulates the +OPFT_HELLO+ OpenFlow message.
+ * @raise [ArgumentError] if transaction ID is not an unsigned 32-bit integer.
+ * @raise [TypeError] if argument is not a Integer or a Hash.
+ * @return [Hello]
  */
 static VALUE
 hello_init( int argc, VALUE *argv, VALUE self ) {
-  buffer *hello;
+  buffer *hello = NULL;
   Data_Get_Struct( self, buffer, hello );
-  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( hello, get_transaction_id() );
+  }
+  else {
+    if ( options == Qnil ) {
+      set_xid( hello, get_transaction_id() );
+    }
+    else if ( rb_obj_is_kind_of( options, rb_cInteger ) == Qtrue ) {
+      validate_xid( options );
+      set_xid( hello, ( 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( hello, ( uint32_t ) NUM2UINT( xid ) );
+      }
+      else {
+        set_xid( hello, get_transaction_id() );
       }
-      xid = ( uint32_t ) NUM2UINT( xid_ruby );
     }
   }
-  ( ( struct ofp_header * ) ( hello->data ) )->xid = htonl( xid );
+
   return self;
 }
 
 
 /*
- * An unsigned 32bit integer number associated with this
- * message. Replies use the same id as was in the request to
- * facilitate pairing.
+ * Transaction ids, message sequence numbers matching requests to replies.
  *
  * @return [Number] the value of transaction ID.
  */
 static VALUE
 hello_transaction_id( VALUE self ) {
-  buffer *hello;
-  Data_Get_Struct( self, buffer, hello );
-  uint32_t xid = ntohl( ( ( struct ofp_header * ) ( hello->data ) )->xid );
-  return UINT2NUM( xid );
+  return get_xid( self );
 }
 
 
@@ -99,6 +122,7 @@ Init_hello() {
   rb_define_alloc_func( cHello, hello_alloc );
   rb_define_method( cHello, "initialize", hello_init, -1 );
   rb_define_method( cHello, "transaction_id", hello_transaction_id, 0 );
+  rb_alias( cHello, rb_intern( "xid" ), rb_intern( "transaction_id" ) );
 }
 
 

data/ruby/trema/hello.h

@@ -1,8 +1,6 @@
 /*
  * Ruby wrapper class of OpenFlow hello message.
  *
- * Author: Yasuhito Takamiya <yasuhito@gmail.com>
- *
  * Copyright (C) 2008-2012 NEC Corporation
  *
  * This program is free software; you can redistribute it and/or modify

data/ruby/trema/ip.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
@@ -90,6 +88,18 @@ module Trema
     def to_i
       @value.to_i
     end
+
+
+    #
+    # @return [Array]
+    #    an array of decimal numbers converted from IP address.
+    #
+    def to_a
+      to_s.split( "." ).collect do | each |
+        each.to_i
+      end
+    end
+    alias :to_array :to_a
   end
 end
 

data/ruby/trema/logger.rb

@@ -0,0 +1,29 @@
+#
+# 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.
+#
+
+
+module Trema
+  module Logger
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8
+### indent-tabs-mode: nil
+### End:

data/ruby/trema/mac.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
@@ -23,7 +21,7 @@ require "forwardable"
 
 module Trema
   #
-  # MAC address class
+  # Ethernet address class
   #
   class Mac
     extend Forwardable
@@ -31,18 +29,23 @@ module Trema
 
 
     #
-    # @return [Number] Ethernet address in its numeric presentation.
+    # Returns an Ethernet address in its numeric presentation.
+    #
+    # @example
+    #   Mac.new("11:22:33:44:55:66") #=> 18838586676582
+    #
+    # @return [Number] the Ethernet address in numeric format
     #
     attr_reader :value
 
 
     #
-    # Creates a {Mac} instance that encapsulates Ethernet MAC addresses.
+    # Creates a {Mac} instance that encapsulates Ethernet addresses.
     #
     # @overload initialize(value)
     #
     # @param [String,Integer] value
-    #   the MAC address to set to.
+    #   the Ethernet address to set to.
     #
     # @example address as a hexadecimal string
     #   Mac.new("11:22:33:44:55:66")
@@ -51,25 +54,30 @@ module Trema
     #   Mac.new(0xffffffffffff)
     #
     # @raise [ArgumentError] if invalid format is detected.
-    # @raise [ArgumentError] if supplied argument is not a string or integer.
+    # @raise [TypeError] if supplied argument is not a String or Integer.
     #
     def initialize value
       case value
-      when String
-        @value = from_string( value )
-      when Integer
-        @value = from_integer( value )
-      else
-        raise %{Invalid MAC address: #{ value.inspect }}
+        when String
+          @value = create_from( value )
+        when Integer
+          @value = value
+          validate_value_range
+        else
+          raise TypeError, "Invalid MAC address: #{ value.inspect }"
       end
       @string = string_format
     end
 
 
     #
-    # @return [String]
-    #  the Ethernet address as 6 pairs of hexadecimal digits delimited by colons.
-    #  eg. xx:xx:xx:xx:xx:xx
+    # Returns the Ethernet address as 6 pairs of hexadecimal digits
+    # delimited by colons.
+    #
+    # @example
+    #   Mac.new(18838586676582).to_s #=> "11:22:33:44:55:66"
+    #
+    # @return [String] the Ethernet address in String format
     #
     def to_s
       @string
@@ -77,11 +85,15 @@ module Trema
 
 
     #
-    # @return [Array] 
-    #   an array of decimal numbers converted from Ethernet's address string
-    #   format.
+    # Returns an array of decimal numbers converted from Ethernet's
+    # address string format.
+    #
+    # @example
+    #   Mac.new("11:22:33:44:55:66").to_a #=> [ 0x11, 0x22, 0x33, 0x44, 0x55, 0x66 ]
     #
-    def to_short
+    # @return [Array] the Ethernet address in Array format
+    #
+    def to_a
       @string.split( ":" ).collect do | each |
         each.hex
       end
@@ -89,27 +101,38 @@ module Trema
 
 
     #
-    # @return [Boolean] if other matches or not the attribute type value.
+    # @private
     #
     def == other
       @value == other.value
     end
+    alias :eql? :==
 
 
     #
-    # @return [Boolean] if other matches or not the attribute type value.
+    # Returns true if Ethernet address is a multicast address.
     #
-    def eql? other
-      @value == other.value
+    # @example
+    #   Mac.new("01:00:00:00:00:00").multicast? #=> true
+    #   Mac.new("00:00:00:00:00:00").multicast? #=> false
+    #
+    # @return [Boolean] whether the Ethernet address is multicast
+    #
+    def multicast?
+      to_a[ 0 ] & 1 == 1
     end
 
 
     #
-    # @return [Boolean] if MAC address is multicast or not.
+    # Returns true if Ethernet address is a broadcast address.
     #
-    def is_multicast?
-      # check I/G bit
-      return to_short[0] & 1 == 1
+    # @example
+    #   Mac.new("ff:ff:ff:ff:ff:ff").broadcast? #=> true
+    #
+    # @return [Boolean] whether the Ethernet address is broadcast
+    #
+    def broadcast?
+      to_a.all? { | each | each == 0xff }
     end
 
 
@@ -118,21 +141,19 @@ module Trema
     ################################################################################
 
 
-    def from_string string
+    def create_from string
       octet_regex = "[0-9a-fA-F][0-9a-fA-F]"
       if /^(#{ octet_regex }:){5}(#{ octet_regex })$/=~ string
-        eval( "0x" + string.gsub( ":", "" ) )
+        string.gsub( ":", "" ).hex
       else
-        raise %{Invalid MAC address: "#{ string }"}
+        raise ArgumentError, %{Invalid MAC address: "#{ string }"}
       end
     end
 
 
-    def from_integer integer
-      if integer >= 0 and integer <= 0xffffffffffff
-        integer
-      else
-        raise %{Invalid MAC address: #{ integer }}
+    def validate_value_range
+      if not ( @value >= 0 and @value <= 0xffffffffffff )
+        raise ArgumentError, "Invalid MAC address: #{ @value }"
       end
     end