trema 0.2.3 → 0.2.4

data/README.md

@@ -17,6 +17,18 @@ testing your own controllers. For debugging, a wireshark plug-in to
 diagnose internal data-flows among functional modules is provided.
 
 
+Supported Platforms
+-------------------
+
+Trema supports GNU/Linux only. And it has been tested on the following environments:
+
+* Ubuntu 12.04, 11.10, 11.04, 10.10, and 10.04 (i386/amd64, Desktop Edition)
+* Debian GNU/Linux 6.0 (i386/amd64)
+
+It may also run on other GNU/Linux distributions but is not tested and
+NOT SUPPORTED at this moment.
+
+
 Getting Started
 ---------------
 
@@ -33,10 +45,84 @@ Getting Started
 * The [Getting Started with Trema](https://github.com/trema/trema/wiki/Quick-start).
 * The [Trema in 10 Minutes Tutorial](http://trema-10min.heroku.com/).
 * The [Trema Tutorial](http://trema-tutorial.heroku.com/).
-* The [Trema Ruby API documents](http://rubydoc.info/github/trema/trema/master/frames).
 * The [Programming Trema Article (in Japanese)](http://gihyo.jp/dev/serial/01/openflow_sd/0007).
 
 
+Ruby API
+--------
+
+The following is an exerpt from the Trema Ruby API.
+The full documents are found here http://rubydoc.info/github/trema/trema/master/frames
+
+### Event and Message Handlers
+
+Subclass
+[Trema::Controller](http://rubydoc.info/github/trema/trema/master/Trema/Controller)
+and override some of the following methods to implement your own
+controller.
+
+* [switch_ready(datapath_id)](http://rubydoc.info/github/trema/trema/master/Trema/Controller:switch_ready)
+* [switch_disconnected(datapath_id)](http://rubydoc.info/github/trema/trema/master/Trema/Controller:switch_disconnected)
+* [packet_in(datapath_id, message)](http://rubydoc.info/github/trema/trema/master/Trema/Controller:packet_in)
+* [flow_removed(datapath_id, message)](http://rubydoc.info/github/trema/trema/master/Trema/Controller:flow_removed)
+* [port_status(datapath_id, message)](http://rubydoc.info/github/trema/trema/master/Trema/Controller:port_status)
+* [openflow_error(datapath_id, message)](http://rubydoc.info/github/trema/trema/master/Trema/Controller:openflow_error)
+* [features_reply(datapath_id, message)](http://rubydoc.info/github/trema/trema/master/Trema/Controller:features_reply)
+* [stats_reply(datapath_id, message)](http://rubydoc.info/github/trema/trema/master/Trema/Controller:stats_reply)
+* [barrier_reply(datapath_id, message)](http://rubydoc.info/github/trema/trema/master/Trema/Controller:barrier_reply)
+* [get_config_reply(datapath_id, message)](http://rubydoc.info/github/trema/trema/master/Trema/Controller:get_config_reply)
+* [queue_get_config_reply(datapath_id, message)](http://rubydoc.info/github/trema/trema/master/Trema/Controller:queue_get_config_reply)
+* [vendor(datapath_id, message)](http://rubydoc.info/github/trema/trema/master/Trema/Controller:vendor)
+
+### Flow-Mod and Packet-Out
+
+For sending Flow-Mod and Packet-Out, there are some methods defined in
+[Trema::Controller](http://rubydoc.info/github/trema/trema/master/Trema/Controller)
+class.
+
+* [send_flow_mod_add(datapath_id, options)](http://rubydoc.info/github/trema/trema/master/Trema/Controller:send_flow_mod_add)
+* [send_flow_mod_delete(datapath_id, options)](http://rubydoc.info/github/trema/trema/master/Trema/Controller:send_flow_mod_delete)
+* [send_flow_mod_modify(datapath_id, options)](http://rubydoc.info/github/trema/trema/master/Trema/Controller:send_flow_mod_modify)
+* [send_packet_out(datapath_id, options)](http://rubydoc.info/github/trema/trema/master/Trema/Controller:send_packet_out)
+
+### Other OpenFlow Messages
+
+The following OpenFlow messages can be sent with
+[Trema::Controller#send_message](http://rubydoc.info/github/trema/trema/master/Trema/Controller:send_message)
+
+* [Trema::FeaturesRequest](http://rubydoc.info/github/trema/trema/master/Trema/FeaturesRequest)
+* [Trema::SetConfigRequest](http://rubydoc.info/github/trema/trema/master/Trema/SetConfigRequest)
+* [Trema::GetConfigRequest](http://rubydoc.info/github/trema/trema/master/Trema/GetConfigRequest)
+* [Trema::QueueGetConfigRequest](http://rubydoc.info/github/trema/trema/master/Trema/QueueGetConfigRequest)
+* [Trema::DescStatsRequest](http://rubydoc.info/github/trema/trema/master/Trema/DescStatsRequest)
+* [Trema::FlowStatsRequest](http://rubydoc.info/github/trema/trema/master/Trema/FlowStatsRequest)
+* [Trema::AggregateStatsRequest](http://rubydoc.info/github/trema/trema/master/Trema/AggregateStatsRequest)
+* [Trema::TableStatsRequest](http://rubydoc.info/github/trema/trema/master/Trema/TableStatsRequest)
+* [Trema::PortStatsRequest](http://rubydoc.info/github/trema/trema/master/Trema/PortStatsRequest)
+* [Trema::QueueStatsRequest](http://rubydoc.info/github/trema/trema/master/Trema/QueueStatsRequest)
+* [Trema::VendorStatsRequest](http://rubydoc.info/github/trema/trema/master/Trema/VendorStatsRequest)
+* [Trema::BarrierRequest](http://rubydoc.info/github/trema/trema/master/Trema/BarrierRequest)
+* [Trema::PortMod](http://rubydoc.info/github/trema/trema/master/Trema/PortMod)
+* [Trema::Vendor](http://rubydoc.info/github/trema/trema/master/Trema/Vendor)
+
+### Actions
+
+Each flow table entry contains a list of actions that will be executed when a packet matches the entry.
+
+* [Trema::SendOutPort](http://rubydoc.info/github/trema/trema/master/Trema/SendOutPort)
+* [Trema::SetEthSrcAddr](http://rubydoc.info/github/trema/trema/master/Trema/SetEthSrcAddr)
+* [Trema::SetEthDstAddr](http://rubydoc.info/github/trema/trema/master/Trema/SetEthDstAddr)
+* [Trema::SetIpSrcAddr](http://rubydoc.info/github/trema/trema/master/Trema/SetIpSrcAddr)
+* [Trema::SetIpDstAddr](http://rubydoc.info/github/trema/trema/master/Trema/SetIpDstAddr)
+* [Trema::SetIpTos](http://rubydoc.info/github/trema/trema/master/Trema/SetIpTos)
+* [Trema::SetTransportSrcPort](http://rubydoc.info/github/trema/trema/master/Trema/SetTransportSrcPort)
+* [Trema::SetTransportDstPort](http://rubydoc.info/github/trema/trema/master/Trema/SetTransportDstPort)
+* [Trema::SetVlanVid](http://rubydoc.info/github/trema/trema/master/Trema/SetVlanVid)
+* [Trema::SetVlanPriority](http://rubydoc.info/github/trema/trema/master/Trema/SetVlanPriority)
+* [Trema::StripVlanHeader](http://rubydoc.info/github/trema/trema/master/Trema/StripVlanHeader)
+* [Trema::VendorAction](http://rubydoc.info/github/trema/trema/master/Trema/VendorAction)
+
+
 Meta
 ----
 
@@ -46,18 +132,6 @@ Meta
 * Twitter: http://twitter.com/trema_news
 
 
-Supported Platforms
--------------------
-
-Trema has been tested ONLY on the following environments:
-
-* Ubuntu 12.04, 11.10, 11.04, 10.10, and 10.04 (i386/amd64, Desktop Edition)
-* Debian GNU/Linux 6.0 (i386/amd64)
-
-It may also run on other GNU/Linux distributions but is not tested and
-NOT SUPPORTED at this moment.
-
-
 Contributors
 ------------
 

data/ruby/trema/barrier-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
@@ -87,7 +85,7 @@ handle_barrier_reply( uint64_t datapath_id, uint32_t transaction_id, void *user_
   }
 
   VALUE barrier_reply = rb_funcall( cBarrierReply, rb_intern( "new" ), 2, ULL2NUM( datapath_id ), UINT2NUM( transaction_id ) );
-  rb_funcall( controller, rb_intern( "barrier_reply" ), 1, barrier_reply );
+  rb_funcall( controller, rb_intern( "barrier_reply" ), 2, ULL2NUM( datapath_id ), barrier_reply );
 }
 
 

data/ruby/trema/controller.rb

@@ -25,7 +25,7 @@ require "trema/timers"
 
 module Trema
   #
-  # The base class of Trema controller.
+  # @abstract The base class of Trema controller. Subclass and override handlers to implement a custom OpenFlow controller.
   #
   class Controller < App
     include Logger
@@ -33,14 +33,176 @@ module Trema
 
 
     #
-    # Callback invoked whenever a subclass of this class is created.
-    # This adds the created object to the DB of controllers.
+    # @private Just a placeholder for YARD.
+    #
+    def self.handler name
+      # Do nothing.
+    end
+
+
+    #
+    # @!method switch_ready( datapath_id )
+    #
+    # @abstract Switch Ready event handler. Override this to implement a custom handler.
+    #
+    # @param [Integer] datapath_id
+    #   the datapath ID of connected OpenFlow switch.
+    #
+    handler :switch_ready
+
+
+    #
+    # @!method switch_disconnected( datapath_id )
+    #
+    # @abstract Switch Disconnected event handler. Override this to implement a custom handler.
+    #
+    # @param [Integer] datapath_id
+    #   the datapath ID of disconnected OpenFlow switch.
+    #
+    handler :switch_disconnected
+
+
+    #
+    # @!method packet_in( datapath_id, message )
+    #
+    # @abstract Packet In message handler. Override this to implement a custom handler.
+    #
+    # @param [Integer] datapath_id
+    #   the datapath from which a message is sent.
+    # @param [PacketIn] message
+    #   the Packet In message.
+    #
+    handler :packet_in
+
+
+    #
+    # @!method flow_removed( datapath_id, message )
+    #
+    # @abstract Flow Removed message handler. Override this to implement a custom handler.
+    #
+    # @param [Integer] datapath_id
+    #   the datapath from which a message is sent.
+    # @param [FlowRemoved] message
+    #   the Flow Removed message.
+    #
+    handler :flow_removed
+
+
+    #
+    # @!method port_status( datapath_id, message )
+    #
+    # @abstract Port Status message handler. Override this to implement a custom handler.
+    #
+    # @param [Integer] datapath_id
+    #   the datapath from which a message is sent.
+    # @param [PortStatus] message
+    #   the Port Status message.
+    #
+    handler :port_status
+
+
+    #
+    # @!method openflow_error( datapath_id, message )
+    #
+    # @abstract OpenFlow Error message handler. Override this to implement a custom handler.
+    #
+    # @param [Integer] datapath_id
+    #   the datapath from which a message is sent.
+    # @param [OpenflowError] message
+    #   the OpenFlow Error message.
+    #
+    handler :openflow_error
+
+
+    #
+    # @!method features_reply( datapath_id, message )
+    #
+    # @abstract Features Reply message handler. Override this to implement a custom handler.
+    #
+    # @param [Integer] datapath_id
+    #   the datapath from which a message is sent.
+    # @param [FeaturesReply] message
+    #   the Features Reply message.
+    #
+    handler :features_reply
+
+
+    #
+    # @!method stats_reply( datapath_id, message )
+    #
+    # @abstract Stats Reply message handler. Override this to implement a custom handler.
+    #
+    # @param [Integer] datapath_id
+    #   the datapath from which a message is sent.
+    # @param [StatsReply] message
+    #   the Stats Reply message.
+    #
+    handler :stats_reply
+
+
+    #
+    # @!method barrier_reply( datapath_id, message )
+    #
+    # @abstract Barrier Reply message handler. Override this to implement a custom handler.
+    #
+    # @param [Integer] datapath_id
+    #   the datapath from which a message is sent.
+    # @param [BarrierReply] message
+    #   the Barrier Reply message.
+    #
+    handler :barrier_reply
+
+
+    #
+    # @!method get_config_reply( datapath_id, message )
+    #
+    # @abstract Get Config Reply message handler. Override this to implement a custom handler.
+    #
+    # @param [Integer] datapath_id
+    #   the datapath from which a message is sent.
+    # @param [GetConfigReply] message
+    #   the Get Config Reply message.
+    #
+    handler :get_config_reply
+
+
+    #
+    # @!method queue_get_config_reply( datapath_id, message )
+    #
+    # @abstract Queue Get Config Reply message handler. Override this to implement a custom handler.
+    #
+    # @param [Integer] datapath_id
+    #   the datapath from which a message is sent.
+    # @param [QueueGetConfigReply] message
+    #   the Queue Get Config Reply message.
+    #
+    handler :queue_get_config_reply
+
+
+    #
+    # @!method vendor( datapath_id, message )
+    #
+    # @abstract Vendor message handler. Override this to implement a custom handler.
+    #
+    # @param [Integer] datapath_id
+    #   the datapath from which a message is sent.
+    # @param [Vendor] message
+    #   the Vendor message.
+    #
+    handler :vendor
+
+
+    #
+    # @private
     #
     def self.inherited subclass
       subclass.new
     end
 
 
+    #
+    # @private
+    #
     def initialize
       App.add self
     end

data/ruby/trema/get-config-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
@@ -29,12 +27,12 @@ VALUE cGetConfigReply;
 /*
  * Handles the response to +OFPT_GET_CONFIG_REQUEST+ message. The user would not
  * explicitly instantiate a {GetConfigReply} object but would be created while
- * parsing the +OFPT_GET_CONFIG_REPLY+ message. The {GetConfigReply} object is 
+ * parsing the +OFPT_GET_CONFIG_REPLY+ message. The {GetConfigReply} object is
  * an object whose attributes represent the return values of the message.
  *
  * @overload initialize(options={})
  *
- *   @example 
+ *   @example
  *     GetConfigReply.new(
  *       :datapath_id => 2748
  *       :transaction_id => 1,
@@ -55,11 +53,11 @@ VALUE cGetConfigReply;
  *     indicates how IP fragments are treated.
  *
  *   @option options [Number] :miss_send_len
- *     the maximum number of bytes to send on a flow table miss or 
+ *     the maximum number of bytes to send on a flow table miss or
  *     flow destined to controller.
  *
- *   @return [GetConfigReply] 
- *     an object that encapsulates the +OFPT_GET_CONFIG_REPLY+ OpenFlow message.   
+ *   @return [GetConfigReply]
+ *     an object that encapsulates the +OFPT_GET_CONFIG_REPLY+ OpenFlow message.
  */
 static VALUE
 get_config_reply_init( VALUE self, VALUE options ) {
@@ -147,7 +145,7 @@ handle_get_config_reply(
   rb_hash_aset( attributes, ID2SYM( rb_intern( "miss_send_len" ) ), UINT2NUM( miss_send_len ) );
 
   VALUE get_config_reply = rb_funcall( cGetConfigReply, rb_intern( "new" ), 1, attributes );
-  rb_funcall( controller, rb_intern( "get_config_reply" ), 1, get_config_reply );
+  rb_funcall( controller, rb_intern( "get_config_reply" ), 2, ULL2NUM( datapath_id ), get_config_reply );
 }
 
 

data/ruby/trema/link.rb

@@ -98,8 +98,8 @@ module Trema
     def add!
       return if real_eth?
       sh "sudo ip link add name #{ @name } type veth peer name #{ @name_peer }"
-      sh "sudo sysctl -w net.ipv6.conf.#{ @name }.disable_ipv6=1 >/dev/null 2>&1"
-      sh "sudo sysctl -w net.ipv6.conf.#{ @name_peer }.disable_ipv6=1 >/dev/null 2>&1"
+      sh "sudo /sbin/sysctl -w net.ipv6.conf.#{ @name }.disable_ipv6=1 >/dev/null 2>&1"
+      sh "sudo /sbin/sysctl -w net.ipv6.conf.#{ @name_peer }.disable_ipv6=1 >/dev/null 2>&1"
     end
 
 

data/ruby/trema/openflow-error.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
@@ -28,7 +26,7 @@ VALUE cOpenflowError;
 
 /*
  * The occurence of reported errors/exceptions manifested as an instance - a
- * {OpenflowError} object. The user would not explicitly instantiate 
+ * {OpenflowError} object. The user would not explicitly instantiate
  * a {OpenflowError} but would be created while parsing the +OFPT_ERROR+ message.
  *
  * @overload initialize(options={})
@@ -179,7 +177,7 @@ handle_openflow_error(
       break;
   }
   VALUE openflow_error = rb_funcall( cOpenflowError, rb_intern( "new" ), 1, attributes );
-  rb_funcall( controller, rb_intern( "openflow_error" ), 1, openflow_error );
+  rb_funcall( controller, rb_intern( "openflow_error" ), 2, ULL2NUM( datapath_id ), openflow_error );
 }
 
 

data/ruby/trema/queue-get-config-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
@@ -48,7 +46,7 @@ VALUE cQueueGetConfigReply;
  *
  *   @option options [Number] :transaction_id
  *     value copied from +OPFT_QUEUE_SET_CONFIG_REQUEST+ message.
- *  
+ *
  *   @option options [Number] :port
  *     the port the queue is attached to.
  *
@@ -100,7 +98,7 @@ queue_get_config_reply_port( VALUE self ) {
 
 /*
  * An array of {PacketQueue} objects. A packet queue is further classified
- * depending on its properties. Currently only a minimum-rate type queue 
+ * depending on its properties. Currently only a minimum-rate type queue
  * supported.
  *
  * @return [Array<PacketQueue>] the value of queues.
@@ -188,7 +186,7 @@ handle_queue_get_config_reply(
     rb_hash_aset( attributes, ID2SYM( rb_intern( "queues" ) ), rb_eval_string( "PacketQueue.queues" ) );
   }
   VALUE queue_get_config_reply = rb_funcall( cQueueGetConfigReply, rb_intern( "new" ), 1, attributes );
-  rb_funcall( controller, rb_intern( "queue_get_config_reply" ), 1, queue_get_config_reply );
+  rb_funcall( controller, rb_intern( "queue_get_config_reply" ), 2, ULL2NUM( datapath_id ), queue_get_config_reply );
 }
 
 

data/ruby/trema/send-out-port.rb

@@ -25,6 +25,9 @@ module Trema
   # An action to output a packet to a port.
   #
   class SendOutPort < Action
+    DEFAULT_MAX_LEN = 2 ** 16 - 1
+
+
     attr_reader :max_len
     attr_reader :port_number
 
@@ -59,29 +62,37 @@ module Trema
       case options
         when Hash
           @port_number = options[ :port_number ] || options[ :port ]
-          @max_len = options[ :max_len ]
-          if @port_number.nil?
-            raise ArgumentError, ":port_number is a mandatory option"
-          end
-          if not @port_number.unsigned_16bit?
-            raise ArgumentError, "Port number must be an unsigned 16-bit integer"
-          end
-          if @max_len
-            if not @max_len.unsigned_16bit?
-              raise ArgumentError, ":max_len must be an unsigned 16-bit integer"
-            end
-          else
-            @max_len = 2 ** 16 - 1
-          end
+          @max_len = options[ :max_len ] || DEFAULT_MAX_LEN
         when Integer
-          if not options.unsigned_16bit?
-            raise ArgumentError, "Port number must be an unsigned 16-bit integer"
-          end
           @port_number = options
-          @max_len = 2 ** 16 - 1
+          @max_len = DEFAULT_MAX_LEN
         else
           raise "Invalid option"
       end
+      check_port_number
+      check_max_len
+    end
+  end
+
+
+  ##############################################################################
+  private
+  ##############################################################################
+
+
+  def check_port_number
+    if @port_number.nil?
+      raise ArgumentError, "Port number is a mandatory option"
+    end
+    if not @port_number.unsigned_16bit?
+      raise ArgumentError, "Port number must be an unsigned 16-bit integer"
+    end
+  end
+
+
+  def check_max_len
+    if not @max_len.unsigned_16bit?
+      raise ArgumentError, "Max length must be an unsigned 16-bit integer"
     end
   end
 

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

@@ -22,7 +22,7 @@ require "trema/mac"
 
 module Trema
   #
-  # A super-class of {SetEthSrcAddr} and {SetEthDstAddr} action.
+  # @abstract The base class of {SetEthSrcAddr} and {SetEthDstAddr} action.
   #
   class SetEthAddr < Action
     attr_reader :mac_address

data/ruby/trema/set-ip-addr.rb

@@ -21,7 +21,7 @@ require "trema/action"
 
 module Trema
   #
-  # A super-class of {SetIpSrcAddr} and {SetIpDstAddr} action.
+  # @abstract The base class of {SetIpSrcAddr} and {SetIpDstAddr} action.
   #
   class SetIpAddr < Action
     attr_reader :ip_address

data/ruby/trema/set-ip-tos.rb

@@ -34,7 +34,7 @@ module Trema
     # @example
     #   SetIpTos.new(32)
     #
-    # @param [Integer] :type_of_service
+    # @param [Integer] type_of_service
     #   the ToS/DSCP field to set to.
     #
     # @raise [ArgumentError] if type_of_service argument is not an unsigned 8-bit Integer.

data/ruby/trema/set-transport-port.rb

@@ -22,7 +22,7 @@ require "trema/monkey-patch/integer"
 
 module Trema
   #
-  # A super-class of {SetTransportSrcPort} and {SetTransportDstPort} action.
+  # @abstract The base class of {SetTransportSrcPort} and {SetTransportDstPort} action.
   #
   class SetTransportPort < Action
     attr_reader :port_number

data/ruby/trema/switch-daemon.rb

@@ -1,8 +1,6 @@
 #
 # The controller class of switch daemon.
 #
-# Author: Yasuhito Takamiya <yasuhito@gmail.com>
-#
 # Copyright (C) 2008-2012 NEC Corporation
 #
 # This program is free software; you can redistribute it and/or modify
@@ -29,7 +27,7 @@ module Trema
 
 
     def options
-      [ portstatus_queue, packetin_queue, statenotify_queue, vendor_queue ]
+      portstatus_queue + packetin_queue + statenotify_queue + vendor_queue
     end
 
 
@@ -46,22 +44,35 @@ module Trema
 
 
     def portstatus_queue
-      "port_status::#{ @queues[ :port_status ] }"
+      controllers = @queues[ :port_status ].split( "," )
+      controllers.collect do | each |
+        "port_status::#{ each }"
+      end
     end
 
 
     def packetin_queue
-      "packet_in::#{ @queues[ :packet_in ] }"
+      controllers = @queues[ :packet_in ].split( "," )
+      controllers.collect do | each |
+        "packet_in::#{ each }"
+      end
     end
 
 
     def statenotify_queue
-      "state_notify::#{ @queues[ :state_notify ] }"
+      controllers = @queues[ :state_notify ].split( "," )
+      controllers.collect do | each |
+        "state_notify::#{ each }"
+      end
     end
 
 
     def vendor_queue
-      "vendor::#{ @queues[ :vendor ] }"
+      return [] if not @queues[ :vendor ]
+      controllers = @queues[ :vendor ].split( "," )
+      controllers.collect do | each |
+        "vendor::#{ each }"
+      end
     end
   end
 end

data/ruby/trema/vendor.c

@@ -209,7 +209,7 @@ handle_vendor(
     rb_hash_aset( attributes, ID2SYM( rb_intern( "data" ) ), rb_str_new( data->data, ( long ) data->length ) );
   }
   VALUE vendor_r = rb_funcall( cVendor, rb_intern( "new" ), 1, attributes );
-  rb_funcall( controller, rb_intern( "vendor" ), 1, vendor_r );
+  rb_funcall( controller, rb_intern( "vendor" ), 2, ULL2NUM( datapath_id ), vendor_r );
 }
 
 

data/ruby/trema/version.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,7 +17,7 @@
 
 
 module Trema
-  VERSION = "0.2.3"
+  VERSION = "0.2.4"
 end
 
 

data/spec/trema/barrier-request_spec.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
@@ -54,8 +52,8 @@ describe BarrierRequest, ".new( OPTIONAL OPTION ) - transaction_id" do
       network {
         vswitch { datapath_id 0xabc }
       }.run( BarrierController ) {
-        controller( "BarrierController" ).should_receive( :barrier_reply ) do | message |
-          message.datapath_id.should == 0xabc
+        controller( "BarrierController" ).should_receive( :barrier_reply ) do | datapath_id, message |
+          datapath_id.should == 0xabc
           message.transaction_id.should == 1234
         end
         barrier_request = BarrierRequest.new( :transaction_id => 1234 )

data/spec/trema/controller_spec.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

data/spec/trema/get-config-reply_spec.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

data/spec/trema/get-config-request_spec.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
@@ -61,8 +59,8 @@ describe GetConfigRequest, ".new( VALID OPTION )" do
         vswitch { datapath_id 0xabc }
       }.run( GetConfigController ) {
         get_config_request = GetConfigRequest.new( :transaction_id => 1234 )
-        controller( "GetConfigController" ).should_receive( :get_config_reply ) do | message |
-          message.datapath_id.should == 0xabc
+        controller( "GetConfigController" ).should_receive( :get_config_reply ) do | datapath_id, message |
+          datapath_id.should == 0xabc
           message.transaction_id.should == 1234
           message.flags.should >= 0 and message.flags.should <= 3
           message.miss_send_len.should == 65535

data/spec/trema/link_spec.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
@@ -38,8 +36,8 @@ module Trema
 
       it "executes ip and ifconfig command" do
         @link.should_receive( :sh ).once.ordered.with( "sudo ip link add name trema0-0 type veth peer name trema0-1" )
-        @link.should_receive( :sh ).once.ordered.with( "sudo sysctl -w net.ipv6.conf.trema0-0.disable_ipv6=1 >/dev/null 2>&1" )
-        @link.should_receive( :sh ).once.ordered.with( "sudo sysctl -w net.ipv6.conf.trema0-1.disable_ipv6=1 >/dev/null 2>&1" )
+        @link.should_receive( :sh ).once.ordered.with( "sudo /sbin/sysctl -w net.ipv6.conf.trema0-0.disable_ipv6=1 >/dev/null 2>&1" )
+        @link.should_receive( :sh ).once.ordered.with( "sudo /sbin/sysctl -w net.ipv6.conf.trema0-1.disable_ipv6=1 >/dev/null 2>&1" )
         @link.should_receive( :sh ).once.ordered.with( "sudo /sbin/ifconfig trema0-0 up" )
         @link.should_receive( :sh ).once.ordered.with( "sudo /sbin/ifconfig trema0-1 up" )
 

data/spec/trema/openflow-error_spec.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
@@ -35,10 +33,10 @@ describe Trema::OpenflowError, "new" do
           :mask => 1,
           :advertise => 0
         )
-        controller( "OpenflowErrorController" ).should_receive( :openflow_error ) do | arg |
-          arg.datapath_id.should == 0xabc
-          arg.type.should == Error::OFPET_PORT_MOD_FAILED
-          arg.code.should == Error::OFPPMFC_BAD_PORT 
+        controller( "OpenflowErrorController" ).should_receive( :openflow_error ) do | datapath_id, message |
+          datapath_id.should == 0xabc
+          message.type.should == Error::OFPET_PORT_MOD_FAILED
+          message.code.should == Error::OFPPMFC_BAD_PORT 
         end
         controller( "OpenflowErrorController" ).send_message( 0xabc, port_mod )
         sleep 2 # FIXME: wait to send_message
@@ -63,10 +61,10 @@ describe Trema::OpenflowError, "new" do
           :mask => 1,
           :advertise => 0
         )
-        controller( "OpenflowErrorController" ).should_receive( :openflow_error ) do | arg |
-          arg.datapath_id.should == 0xabc
-          arg.type.should == Error::OFPET_PORT_MOD_FAILED
-          arg.code.should == Error::OFPPMFC_BAD_HW_ADDR
+        controller( "OpenflowErrorController" ).should_receive( :openflow_error ) do | datapath_id, message |
+          datapath_id.should == 0xabc
+          message.type.should == Error::OFPET_PORT_MOD_FAILED
+          message.code.should == Error::OFPPMFC_BAD_HW_ADDR
         end
         controller( "OpenflowErrorController" ).send_message( 0xabc, port_mod )
         sleep 2 # FIXME: wait to send_message
@@ -85,10 +83,10 @@ describe Trema::OpenflowError, "new" do
         link "host1", "error-port"
         link "host2", "error-port"
       }.run( OpenflowErrorController ) {
-        controller( "OpenflowErrorController" ).should_receive( :openflow_error ) do | arg |
-          arg.datapath_id.should == 0xabc
-          arg.type.should == Error::OFPET_BAD_ACTION
-          arg.code.should == Error::OFPBAC_BAD_OUT_PORT
+        controller( "OpenflowErrorController" ).should_receive( :openflow_error ) do | datapath_id, message |
+          datapath_id.should == 0xabc
+          message.type.should == Error::OFPET_BAD_ACTION
+          message.code.should == Error::OFPBAC_BAD_OUT_PORT
         end
         controller( "OpenflowErrorController" ).send_flow_mod_add( 0xabc, :actions => ActionOutput.new( :port => 0x5555 ) )
         sleep 2 # FIXME: wait to send_flow_mod_add
@@ -104,7 +102,7 @@ describe Trema::OpenflowError, "new" do
         vswitch( "error-request") { datapath_id 0xabc }
       }.run( OpenflowController ) {
         queue_get_config_request = Trema::QueueGetConfigRequest.new( :port => 1 )
-        controller( "OpenflowController" ).should_receive( :openflow_error ) do | message |
+        controller( "OpenflowController" ).should_receive( :openflow_error ) do | datapath_id, message |
           message.datapath_id.should == 0xabc
           message.type.should satisfy { | n |
             n >= 0 && n <= 5

data/spec/trema/set-config_spec.rb

@@ -58,7 +58,7 @@ describe SetConfig, ".new( VALID OPTIONS )" do
       network {
         vswitch { datapath_id 0xabc }
       }.run( SetConfigController ) {
-        controller( "SetConfigController" ).should_receive( :get_config_reply ) do | arg |
+        controller( "SetConfigController" ).should_receive( :get_config_reply ) do | dpid, arg |
           arg.flags.should == 0
           arg.miss_send_len.should == 0
         end

data/spec/trema/switch-daemon_spec.rb

@@ -23,10 +23,52 @@ require "trema/switch-daemon"
 module Trema
   describe SwitchDaemon do
     it "should be initialized with proper options" do
-      rule = { :port_status => "topology", :packet_in => "controller", :state_notify => "topology", :vendor => "controller" }
+      rule = {
+        :port_status => "topology",
+        :packet_in => "controller",
+        :state_notify => "topology",
+        :vendor => "controller"
+      }
       switch_daemon = SwitchDaemon.new( rule )
 
-      switch_daemon.options.should == [ "port_status::topology", "packet_in::controller", "state_notify::topology", "vendor::controller" ]
+      switch_daemon.options.should include( "port_status::topology" )
+      switch_daemon.options.should include( "packet_in::controller" )
+      switch_daemon.options.should include( "state_notify::topology" )
+      switch_daemon.options.should include( "vendor::controller" )
+    end
+
+
+    it "should be initialized with options which have multiple controllers" do
+      rule = {
+        :port_status => "topology0,topology1",
+        :packet_in => "controller0,controller1",
+        :state_notify => "topology0,topology1",
+        :vendor => "controller0,controller1"
+      }
+      switch_daemon = SwitchDaemon.new( rule )
+
+      switch_daemon.options.should include( "port_status::topology0" )
+      switch_daemon.options.should include( "port_status::topology1" )
+      switch_daemon.options.should include( "packet_in::controller0" )
+      switch_daemon.options.should include( "packet_in::controller1" )
+      switch_daemon.options.should include( "state_notify::topology0" )
+      switch_daemon.options.should include( "state_notify::topology1" )
+      switch_daemon.options.should include( "vendor::controller0" )
+      switch_daemon.options.should include( "vendor::controller1" )
+    end
+
+
+    it "should be initialized without vendor options" do
+      rule = {
+        :port_status => "topology",
+        :packet_in => "controller",
+        :state_notify => "topology"
+      }
+      switch_daemon = SwitchDaemon.new( rule )
+
+      switch_daemon.options.should include( "port_status::topology" )
+      switch_daemon.options.should include( "packet_in::controller" )
+      switch_daemon.options.should include( "state_notify::topology" )
     end
   end
 end

data/src/examples/dumper/dumper.rb

@@ -1,8 +1,4 @@
 #
-# Openflow message event dumper.
-#
-# Author: Nick Karanatsios <nickkaranatsios@gmail.com>
-#
 # Copyright (C) 2008-2012 NEC Corporation
 #
 # This program is free software; you can redistribute it and/or modify
@@ -20,6 +16,9 @@
 #
 
 
+#
+# Openflow message event dumper.
+#
 class Dumper < Controller
   def switch_ready datapath_id
     info "[switch_ready]"
@@ -33,9 +32,9 @@ class Dumper < Controller
   end
 
 
-  def openflow_error message
+  def openflow_error datapath_id, message
     info "[error]"
-    info "datapath_id: #{ message.datapath_id.to_hex }"
+    info "datapath_id: #{ datapath_id.to_hex }"
     info "transaction_id: #{ message.transaction_id.to_hex }"
     info "type: #{ message.type.to_hex }"
     info "code: #{ message.code.to_hex }"
@@ -43,9 +42,9 @@ class Dumper < Controller
   end
 
 
-  def vendor message
+  def vendor datapath_id, message
     info "[vendor]"
-    info "datapath_id: #{ message.datapath_id.to_hex }"
+    info "datapath_id: #{ datapath_id.to_hex }"
     info "transaction_id: #{ message.transaction_id.to_hex }"
     info "data:"
     info "#{ message.buffer.unpack "H*" }"
@@ -66,9 +65,9 @@ class Dumper < Controller
   end
 
 
-  def get_config_reply message
+  def get_config_reply datapath_id, message
     info "[get_config_reply]"
-    info "datapath_id: #{ message.datapath_id.to_hex }"
+    info "datapath_id: #{ datapath_id.to_hex }"
     info "transaction_id: #{ message.transaction_id.to_hex }"
     info "flags: #{ message.flags.to_hex }"
     info "miss_send_len: #{ message.miss_send_len }"
@@ -127,9 +126,9 @@ class Dumper < Controller
   end
 
 
-  def stats_reply message
+  def stats_reply datapath_id, message
     info "[stats_reply]"
-    info "datapath_id: #{ message.datapath_id.to_hex }"
+    info "datapath_id: #{ datapath_id.to_hex }"
     info "transaction_id: #{ message.transaction_id.to_hex }"
     info "type: #{ message.type.to_hex }"
     info "flags: #{ message.flags.to_hex }"
@@ -137,16 +136,16 @@ class Dumper < Controller
   end
 
 
-  def barrier_reply message
+  def barrier_reply datapath_id, message
     info "[barrier_reply]"
-    info "datapath_id: #{ message.datapath_id.to_hex }"
+    info "datapath_id: #{ datapath_id.to_hex }"
     info "transaction_id: #{ message.transaction_id.to_hex }"
   end
 
 
-  def queue_get_config_reply message
+  def queue_get_config_reply datapath_id, message
     info "[queue_get_config_reply]"
-    info "datapath_id: #{ message.datapath_id.to_hex }"
+    info "datapath_id: #{ datapath_id.to_hex }"
     info "transaction_id: #{ message.transaction_id.to_hex }"
     info "port: #{ message.port }"
     info( "queues:" );

data/src/lib/openflow_message.c

@@ -3979,19 +3979,13 @@ set_match_from_packet( struct ofp_match *match, const uint16_t in_port,
     if ( !( wildcards & OFPFW_NW_PROTO ) ) {
       match->nw_proto = ( ( packet_info * ) packet->user_data )->ipv4_protocol;
     }
-    if ( ( wildcards & OFPFW_NW_SRC_MASK ) == 0 ) {
-      match->nw_src = ( ( packet_info * ) packet->user_data )->ipv4_saddr;
+    unsigned int nw_src_mask_len = ( wildcards & OFPFW_NW_SRC_MASK ) >> OFPFW_NW_SRC_SHIFT;
+    if ( nw_src_mask_len < 32 ) {
+      match->nw_src = ( ( packet_info * ) packet->user_data )->ipv4_saddr & ( 0xffffffff << nw_src_mask_len );
     }
-    else {
-      match->nw_src = ( ( packet_info * ) packet->user_data )->ipv4_saddr &
-        ( ( wildcards & OFPFW_NW_SRC_MASK ) >> OFPFW_NW_SRC_SHIFT );
-    }
-    if ( ( wildcards & OFPFW_NW_DST_MASK ) == 0 ) {
-      match->nw_dst = ( ( packet_info * ) packet->user_data )->ipv4_daddr;
-    }
-    else {
-      match->nw_dst = ( ( packet_info * ) packet->user_data )->ipv4_daddr &
-        ( ( wildcards & OFPFW_NW_DST_MASK ) >> OFPFW_NW_DST_SHIFT );
+    unsigned int nw_dst_mask_len = ( wildcards & OFPFW_NW_DST_MASK ) >> OFPFW_NW_DST_SHIFT;
+    if ( nw_dst_mask_len < 32 ) {
+      match->nw_dst = ( ( packet_info * ) packet->user_data )->ipv4_daddr & ( 0xffffffff << nw_dst_mask_len );
     }
 
     switch ( match->nw_proto ) {
@@ -4028,17 +4022,13 @@ set_match_from_packet( struct ofp_match *match, const uint16_t in_port,
     if ( !( wildcards & OFPFW_NW_PROTO ) ) {
       match->nw_proto = ( uint8_t ) ( ( ( packet_info * ) packet->user_data )->arp_ar_op & ARP_OP_MASK );
     }
-    if ( ( wildcards & OFPFW_NW_SRC_MASK ) == 0 ) {
-      match->nw_src = ( ( packet_info * ) packet->user_data )->arp_spa;
+    unsigned int nw_src_mask_len = ( wildcards & OFPFW_NW_SRC_MASK ) >> OFPFW_NW_SRC_SHIFT;
+    if ( nw_src_mask_len < 32 ) {
+      match->nw_src = ( ( packet_info * ) packet->user_data )->arp_spa & ( 0xffffffff << nw_src_mask_len );
     }
-    else {
-      match->nw_src = ( ( packet_info * ) packet->user_data )->arp_spa & ( ( wildcards & OFPFW_NW_SRC_MASK ) >> OFPFW_NW_SRC_SHIFT );
-    }
-    if ( ( wildcards & OFPFW_NW_DST_MASK ) == 0 ) {
-      match->nw_dst = ( ( packet_info * ) packet->user_data )->arp_tpa;
-    }
-    else {
-      match->nw_dst = ( ( packet_info * ) packet->user_data )->arp_tpa & ( ( wildcards & OFPFW_NW_DST_MASK ) >> OFPFW_NW_DST_SHIFT );
+    unsigned int nw_dst_mask_len = ( wildcards & OFPFW_NW_DST_MASK ) >> OFPFW_NW_DST_SHIFT;
+    if ( nw_dst_mask_len < 32 ) {
+      match->nw_dst = ( ( packet_info * ) packet->user_data )->arp_tpa & ( 0xffffffff << nw_dst_mask_len );
     }
   }
 }

data/unittests/lib/openflow_message_test.c

@@ -5881,8 +5881,7 @@ test_set_match_from_packet_succeeds_if_datatype_is_ipv4_udp_and_wildcards_is_OFP
   assert_int_equal( match.dl_type, packet_info0->eth_type );
   assert_int_equal( match.nw_tos, ipv4->tos );
   assert_int_equal( match.nw_proto, packet_info0->ipv4_protocol );
-  uint32_t ip_source_address_flag = ntohl( ipv4->saddr ) & ( OFPFW_NW_SRC_ALL >> OFPFW_NW_SRC_SHIFT );
-  assert_int_equal( match.nw_src, ip_source_address_flag );
+  assert_int_equal( match.nw_src, 0 );
   assert_int_equal( match.nw_dst, ntohl( ipv4->daddr ) );
   assert_int_equal( match.tp_src, ntohs( udp->src_port ) );
   assert_int_equal( match.tp_dst, ntohs( udp->dst_port ) );
@@ -5912,8 +5911,7 @@ test_set_match_from_packet_succeeds_if_datatype_is_ipv4_udp_and_wildcards_is_OFP
   assert_int_equal( match.nw_tos, ipv4->tos );
   assert_int_equal( match.nw_proto, packet_info0->ipv4_protocol );
   assert_int_equal( match.nw_src, ntohl( ipv4->saddr ) );
-  uint32_t ip_destination_address_flag = ntohl( ipv4->daddr ) & ( OFPFW_NW_DST_ALL >> OFPFW_NW_DST_SHIFT );
-  assert_int_equal( match.nw_dst, ip_destination_address_flag );
+  assert_int_equal( match.nw_dst, 0 );
   assert_int_equal( match.tp_src, ntohs( udp->src_port ) );
   assert_int_equal( match.tp_dst, ntohs( udp->dst_port ) );
 
@@ -6301,8 +6299,7 @@ test_set_match_from_packet_succeeds_if_datatype_is_ipv4_tcp_and_wildcards_is_OFP
   assert_int_equal( match.dl_type, packet_info0->eth_type );
   assert_int_equal( match.nw_tos, ipv4->tos );
   assert_int_equal( match.nw_proto, packet_info0->ipv4_protocol );
-  uint32_t ip_source_address_flag = ntohl( ipv4->saddr ) & ( OFPFW_NW_SRC_ALL >> OFPFW_NW_SRC_SHIFT );
-  assert_int_equal( match.nw_src, ip_source_address_flag );
+  assert_int_equal( match.nw_src, 0 );
   assert_int_equal( match.nw_dst, ntohl( ipv4->daddr ) );
   assert_int_equal( match.tp_src, ntohs( tcp->src_port ) );
   assert_int_equal( match.tp_dst, ntohs( tcp->dst_port ) );
@@ -6332,8 +6329,7 @@ test_set_match_from_packet_succeeds_if_datatype_is_ipv4_tcp_and_wildcards_is_OFP
   assert_int_equal( match.nw_tos, ipv4->tos );
   assert_int_equal( match.nw_proto, packet_info0->ipv4_protocol );
   assert_int_equal( match.nw_src, ntohl( ipv4->saddr ) );
-  uint32_t ip_destination_address_flag = ntohl( ipv4->daddr ) & ( OFPFW_NW_DST_ALL >> OFPFW_NW_DST_SHIFT );
-  assert_int_equal( match.nw_dst, ip_destination_address_flag );
+  assert_int_equal( match.nw_dst, 0 );
   assert_int_equal( match.tp_src, ntohs( tcp->src_port ) );
   assert_int_equal( match.tp_dst, ntohs( tcp->dst_port ) );
 
@@ -6720,8 +6716,7 @@ test_set_match_from_packet_succeeds_if_datatype_is_ipv4_icmp_and_wildcards_is_OF
   assert_int_equal( match.dl_type, packet_info0->eth_type );
   assert_int_equal( match.nw_tos, ipv4->tos );
   assert_int_equal( match.nw_proto, packet_info0->ipv4_protocol );
-  uint32_t ip_source_address_flag = ntohl( ipv4->saddr ) & ( OFPFW_NW_SRC_ALL >> OFPFW_NW_SRC_SHIFT );
-  assert_int_equal( match.nw_src, ip_source_address_flag );
+  assert_int_equal( match.nw_src, 0 );
   assert_int_equal( match.nw_dst, ntohl( ipv4->daddr ) );
   assert_int_equal( match.icmp_type, icmp->type );
   assert_int_equal( match.icmp_code, icmp->code );
@@ -6751,8 +6746,7 @@ test_set_match_from_packet_succeeds_if_datatype_is_ipv4_icmp_and_wildcards_is_OF
   assert_int_equal( match.nw_tos, ipv4->tos );
   assert_int_equal( match.nw_proto, packet_info0->ipv4_protocol );
   assert_int_equal( match.nw_src, ntohl( ipv4->saddr ) );
-  uint32_t ip_destination_address_flag = ntohl( ipv4->daddr ) & ( OFPFW_NW_DST_ALL >> OFPFW_NW_DST_SHIFT );
-  assert_int_equal( match.nw_dst, ip_destination_address_flag );
+  assert_int_equal( match.nw_dst, 0 );
   assert_int_equal( match.icmp_type, icmp->type );
   assert_int_equal( match.icmp_code, icmp->code );
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: trema
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 31
   prerelease: 
   segments: 
   - 0
   - 2
-  - 3
-  version: 0.2.3
+  - 4
+  version: 0.2.4
 platform: ruby
 authors: 
 - Yasuhito Takamiya
@@ -15,7 +15,7 @@ autorequire:
 bindir: .
 cert_chain: []
 
-date: 2012-07-30 00:00:00 Z
+date: 2012-07-31 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rake
@@ -700,7 +700,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Full-Stack OpenFlow Framework for Ruby and C