trema 0.2.2.1 → 0.2.3

data/ruby/trema/{packet_in.h → packet-in.h}

@@ -1,8 +1,6 @@
 /*
  * Ruby wrapper class of OpenFlow packet_in 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/packet-queue.rb

@@ -20,8 +20,9 @@
 
 class Queue
   class << self
-    # @param [PacketQueue] queue
-    #  the {PacketQueue} to append to the list.
+    #
+    # The {PacketQueue} to append to the list.
+    #
     attr_accessor :queues
   end
 
@@ -175,4 +176,4 @@ end
 ### mode: Ruby
 ### coding: utf-8-unix
 ### indent-tabs-mode: nil
-### End:
+### End:

data/ruby/trema/port-mod.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
@@ -46,7 +44,7 @@ port_mod_alloc( VALUE kclass ) {
  * @overload initialize(options={})
  *   @example
  *     PortMod.new(
- *       :port_no => 1, 
+ *       :port_no => 1,
  *       :hw_addr => "11:22:33:44:55:66",
  *       :config => 1,
  *       :mask => 1,
@@ -56,7 +54,7 @@ port_mod_alloc( VALUE kclass ) {
  *   @param [Hash] options
  *     the options to create a message with.
  *
- *   @param [Number] :port_no 
+ *   @param [Number] :port_no
  *     an index into datapath's ports list.
  *
  *   @param [String,Number,Trema::Mac] :hw_addr
@@ -64,10 +62,10 @@ port_mod_alloc( VALUE kclass ) {
  *     Unique for each port. Obtained from +OFPT_FEATURES_REPLY+ message.
  *     Can be supplied as a string, number or as a Mac object.
  *
- *   @param [Number] :config 
+ *   @param [Number] :config
  *     a bitmap that can be set to configure a port.
  *
- *   @param [Number] :mask 
+ *   @param [Number] :mask
  *     set the bits of the +config+ flag to change.
  *
  *   @param [Number] :advertise
@@ -98,7 +96,7 @@ port_mod_init( int argc, VALUE *argv, VALUE self ) {
       } else if ( rb_obj_is_instance_of( hw_addr, rb_eval_string( "Trema::Mac" ) ) == Qfalse ) {
         rb_raise( rb_eArgError, "hw_addr must be a string or an integer or Mac object" );
       }
-      ptr = ( uint8_t* ) dl_addr_short( mac, haddr );
+      ptr = ( uint8_t* ) dl_addr_to_a( mac, haddr );
       rb_iv_set( self, "@hw_addr", mac );
     }
     VALUE port_no;
@@ -171,7 +169,7 @@ port_mod_hw_addr( VALUE self ) {
 
 
 /*
- * A port can be administratively brought down, disable flooding or packet 
+ * A port can be administratively brought down, disable flooding or packet
  * forwarding or any other options as per +ofp_port_config+. flags.
  *
  * @return [Number] the value of config.
@@ -196,7 +194,7 @@ port_mod_mask( VALUE self ) {
 /*
  * Set to zero to prevent any changes.
  *
- * @return [Number] the value of advertise. 
+ * @return [Number] the value of advertise.
  */
 static VALUE
 port_mod_advertise( VALUE self ) {
@@ -210,6 +208,7 @@ Init_port_mod() {
   rb_define_alloc_func( cPortMod, port_mod_alloc );
   rb_define_method( cPortMod, "initialize", port_mod_init, -1 );
   rb_define_method( cPortMod, "transaction_id", port_mod_transaction_id, 0 );
+  rb_alias( cPortMod, rb_intern( "xid" ), rb_intern( "transaction_id" ) );
   rb_define_method( cPortMod, "port_no", port_mod_port_no, 0 );
   rb_define_method( cPortMod, "hw_addr", port_mod_hw_addr, 0 );
   rb_define_method( cPortMod, "config", port_mod_config, 0 );

data/ruby/trema/port-status-add.rb

@@ -0,0 +1,60 @@
+#
+# 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
+  #
+  # As physical ports are added to the datapath, the controller needs
+  # to be informed with this message.
+  #
+  class PortStatusAdd < PortStatus
+    #
+    # Creates a port-added message.
+    #
+    # @example
+    #   PortStatusAdd.new(
+    #     :datapath_id => 0xabc,
+    #     :transaction_id => 123,
+    #     :phy_port => port
+    #   )
+    #
+    # @param [Hash] options
+    #   the options to create a message with.
+    #
+    # @option options [Number] :datapath_id
+    #   message originator identifier.
+    #
+    # @option options [Number] :transaction_id
+    #   unsolicited message transaction_id is zero.
+    #
+    # @option options [Port] :phy_port
+    #   a {Port} object describing the properties of the port.
+    #
+    # @return [PortStatusAdd]
+    #
+    def initialize options
+      super options.merge( :reason => OFPPR_ADD )
+    end
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8
+### indent-tabs-mode: nil
+### End:

data/ruby/trema/port-status-delete.rb

@@ -0,0 +1,60 @@
+#
+# 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
+  #
+  # As physical ports are deleted from the datapath, the controller
+  # needs to be informed with this message.
+  #
+  class PortStatusDelete < PortStatus
+    #
+    # Creates a port-deleted message.
+    #
+    # @example
+    #   PortStatusDelete.new(
+    #     :datapath_id => 0xabc,
+    #     :transaction_id => 123,
+    #     :phy_port => port
+    #   )
+    #
+    # @param [Hash] options
+    #   the options to create a message with.
+    #
+    # @option options [Number] :datapath_id
+    #   message originator identifier.
+    #
+    # @option options [Number] :transaction_id
+    #   unsolicited message transaction_id is zero.
+    #
+    # @option options [Port] :phy_port
+    #   a {Port} object describing the properties of the port.
+    #
+    # @return [PortStatusDelete]
+    #
+    def initialize options
+      super options.merge( :reason => OFPPR_DELETE )
+    end
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8
+### indent-tabs-mode: nil
+### End:

data/ruby/trema/port-status-modify.rb

@@ -0,0 +1,60 @@
+#
+# 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
+  #
+  # As physical ports of the datapath are modified, the controller
+  # needs to be informed with this message.
+  #
+  class PortStatusModify < PortStatus
+    #
+    # Creates a port-modified message.
+    #
+    # @example
+    #   PortStatusModify.new(
+    #     :datapath_id => 0xabc,
+    #     :transaction_id => 123,
+    #     :phy_port => port
+    #   )
+    #
+    # @param [Hash] options
+    #   the options to create a message with.
+    #
+    # @option options [Number] :datapath_id
+    #   message originator identifier.
+    #
+    # @option options [Number] :transaction_id
+    #   unsolicited message transaction_id is zero.
+    #
+    # @option options [Port] :phy_port
+    #   a {Port} object describing the properties of the port.
+    #
+    # @return [PortStatusModify]
+    #
+    def initialize options
+      super options.merge( :reason => OFPPR_MODIFY )
+    end
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8
+### indent-tabs-mode: nil
+### End:

data/ruby/trema/port-status.c

@@ -28,17 +28,15 @@ VALUE cPortStatus;
 
 
 /*
- * An object that is implemented to wrap the details of the +OFPT_PORT_STATUS+
- * asynchronous message. This message is sent when a state transition on any
- * physical port is detected.
+ * Creates a port status message.
  *
- * @overload initialize(options={})
+ * @overload initialize(options)
  *   @example
  *     PortStatus.new(
- *       :datapath_id => 2748,
- *       :transaction_id => 0,
- *       :reason => 2,
- *       :phy_port => Port
+ *       :datapath_id => 0xabc,
+ *       :transaction_id => 123,
+ *       :reason => PortStatus::OFPPR_ADD,
+ *       :phy_port => port
  *     )
  *
  *   @param [Hash] options
@@ -57,10 +55,22 @@ VALUE cPortStatus;
  *     a {Port} object describing the properties of the port.
  *
  *   @return [PortStatus]
- *     an object that encapsulates the +OFPT_PORT_STATUS+ OpenFlow message.
  */
 static VALUE
 port_status_init( VALUE self, VALUE options ) {
+  if ( rb_hash_aref( options, ID2SYM( rb_intern( "datapath_id" ) ) ) == Qnil ) {
+    rb_raise( rb_eArgError, ":datapath_id is a mandatory option" );
+  }
+  if ( rb_hash_aref( options, ID2SYM( rb_intern( "transaction_id" ) ) ) == Qnil ) {
+    rb_raise( rb_eArgError, ":transaction_id is a mandatory option" );
+  }
+  if ( rb_hash_aref( options, ID2SYM( rb_intern( "reason" ) ) ) == Qnil ) {
+    rb_raise( rb_eArgError, ":reason is a mandatory option" );
+  }
+  if ( rb_hash_aref( options, ID2SYM( rb_intern( "phy_port" ) ) ) == Qnil ) {
+    rb_raise( rb_eArgError, ":phy_port is a mandatory option" );
+  }
+
   rb_iv_set( self, "@attribute", options );
   return self;
 }
@@ -113,15 +123,27 @@ port_status_phy_port( VALUE self ) {
 void
 Init_port_status() {
   cPortStatus = rb_define_class_under( mTrema, "PortStatus", rb_cObject );
+
+  rb_define_const( cPortStatus, "OFPPR_ADD", INT2NUM( OFPPR_ADD ) );
+  rb_define_const( cPortStatus, "OFPPR_DELETE", INT2NUM( OFPPR_DELETE ) );
+  rb_define_const( cPortStatus, "OFPPR_MODIFY", INT2NUM( OFPPR_MODIFY ) );
+
   rb_define_method( cPortStatus, "initialize", port_status_init, 1 );
   rb_define_method( cPortStatus, "datapath_id", port_status_datapath_id, 0 );
+  rb_alias( cPortStatus, rb_intern( "dpid" ), rb_intern( "datapath_id" ) );
   rb_define_method( cPortStatus, "transaction_id", port_status_transaction_id, 0 );
+  rb_alias( cPortStatus, rb_intern( "xid" ), rb_intern( "transaction_id" ) );
   rb_define_method( cPortStatus, "reason", port_status_reason, 0 );
   rb_define_method( cPortStatus, "phy_port", port_status_phy_port, 0 );
+
+  rb_require( "trema/port-status-add" );
+  rb_require( "trema/port-status-delete" );
+  rb_require( "trema/port-status-modify" );
 }
 
+
 /*
- * Handler called when +OFPT_PORT_STATUS+ message is received.
+ * Handler called when a port status message is received.
  */
 void
 handle_port_status(
@@ -132,19 +154,30 @@ handle_port_status(
   void *user_data
 ) {
   VALUE controller = ( VALUE ) user_data;
+
   if ( rb_respond_to( controller, rb_intern( "port_status" ) ) == Qfalse ) {
     return;
   }
-  VALUE attributes = rb_hash_new();
 
+  VALUE attributes = rb_hash_new();
   rb_hash_aset( attributes, ID2SYM( rb_intern( "datapath_id" ) ), ULL2NUM( datapath_id ) );
   rb_hash_aset( attributes, ID2SYM( rb_intern( "transaction_id" ) ), UINT2NUM( transaction_id ) );
-  rb_hash_aset( attributes, ID2SYM( rb_intern( "reason" ) ), UINT2NUM( reason ) );
-
   rb_hash_aset( attributes, ID2SYM( rb_intern( "phy_port" ) ), port_from( &phy_port ) );
 
-  VALUE port_status = rb_funcall( cPortStatus, rb_intern( "new" ), 1, attributes );
-  rb_funcall( controller, rb_intern( "port_status" ), 1, port_status );
+  VALUE port_status = Qnil;
+  if ( reason == OFPPR_ADD ) {
+    port_status = rb_funcall( rb_eval_string( "Trema::PortStatusAdd" ), rb_intern( "new" ), 1, attributes );
+  }
+  else if ( reason == OFPPR_DELETE ) {
+    port_status = rb_funcall( rb_eval_string( "Trema::PortStatusDelete" ), rb_intern( "new" ), 1, attributes );
+  }
+  else if ( reason == OFPPR_MODIFY ) {
+    port_status = rb_funcall( rb_eval_string( "Trema::PortStatusModify" ), rb_intern( "new" ), 1, attributes );
+  }
+  else {
+    rb_raise( rb_eArgError, "Unknown port-status reason." );
+  }
+  rb_funcall( controller, rb_intern( "port_status" ), 2, ULL2NUM( datapath_id ), port_status );
 }
 
 

data/ruby/trema/port-status.h

@@ -26,15 +26,13 @@ extern VALUE cPortStatus;
 
 
 void Init_port_status( void );
-
-
 void handle_port_status(
-        uint64_t datapath_id,
-        uint32_t transaction_id,
-        uint8_t reason,
-        struct ofp_phy_port phy_port,
-        void *user_data
-        );
+  uint64_t datapath_id,
+  uint32_t transaction_id,
+  uint8_t reason,
+  struct ofp_phy_port phy_port,
+  void *user_data
+);
 
 
 /*

data/ruby/trema/port.c

@@ -87,7 +87,7 @@ port_init( VALUE self, VALUE options ) {
 
   VALUE name = rb_hash_aref( options, ID2SYM( rb_intern( "name" ) ) );
   rb_iv_set( self, "@name", name );
-  
+
   VALUE config = rb_hash_aref( options, ID2SYM( rb_intern( "config" ) ) );
   rb_iv_set( self, "@config", config );
 
@@ -191,7 +191,7 @@ port_advertised( VALUE self ) {
  *
  * @return [Number] the value of supported.
  */
-static VALUE 
+static VALUE
 port_supported( VALUE self ) {
   return rb_iv_get( self, "@supported" );
 }
@@ -219,10 +219,6 @@ port_up( VALUE self ) {
   if ( ( config & OFPPC_PORT_DOWN ) == OFPPC_PORT_DOWN ) {
     return Qfalse;
   }
-  uint32_t state = ( uint16_t ) NUM2UINT( rb_iv_get( self, "@state" ) );
-  if ( ( state & OFPPS_LINK_DOWN ) == OFPPS_LINK_DOWN ) {
-    return Qfalse;
-  }
   return Qtrue;
 }
 
@@ -238,6 +234,57 @@ port_down( VALUE self ) {
 }
 
 
+/*
+ * Tests if the link is up.
+ *
+ * @return [Boolean] true if link is up otherwise false.
+ */
+static VALUE
+link_up( VALUE self ) {
+  uint32_t state = ( uint16_t ) NUM2UINT( rb_iv_get( self, "@state" ) );
+  if ( ( state & OFPPS_LINK_DOWN ) == OFPPS_LINK_DOWN ) {
+    return Qfalse;
+  }
+  return Qtrue;
+}
+
+
+/*
+ * Tests if the link is down.
+ *
+ * @return [Boolean] true if link is down otherwise false.
+ */
+static VALUE
+link_down( VALUE self ) {
+  return link_up( self ) == Qfalse ? Qtrue : Qfalse;
+}
+
+
+/*
+ * Tests if the link and port are both up.
+ *
+ * @return [Boolean] true if link is up otherwise false.
+ */
+static VALUE
+port_and_link_up( VALUE self ) {
+  if ( port_up( self ) == Qtrue && link_up( self ) == Qtrue ) {
+    return Qtrue;
+  }
+  return Qfalse;
+}
+
+
+/*
+ * Tests if the link or port is down.
+ *
+ * @return [Boolean] true if link is up otherwise false.
+ */
+static VALUE
+port_or_link_down( VALUE self ) {
+  return port_and_link_up( self ) == Qfalse ? Qtrue : Qfalse;
+}
+
+
 /*
  * Compares two ports by substracting their unique numbers.
  *
@@ -254,6 +301,10 @@ port_compare( VALUE self, VALUE other ) {
 void
 Init_port() {
   cPort = rb_define_class_under( mTrema, "Port", rb_cObject );
+
+  rb_define_const( cPort, "OFPPC_PORT_DOWN", INT2NUM( OFPPC_PORT_DOWN ) );
+  rb_define_const( cPort, "OFPPS_LINK_DOWN", INT2NUM( OFPPS_LINK_DOWN ) );
+
   rb_define_method( cPort, "initialize", port_init, 1 );
   rb_define_method( cPort, "number", port_number, 0 );
   rb_define_method( cPort, "hw_addr", port_hw_addr, 0 );
@@ -264,8 +315,12 @@ Init_port() {
   rb_define_method( cPort, "advertised", port_advertised, 0 );
   rb_define_method( cPort, "supported", port_supported, 0 );
   rb_define_method( cPort, "peer", port_peer, 0 );
-  rb_define_method( cPort, "up?", port_up, 0 );
-  rb_define_method( cPort, "down?", port_down, 0 );
+  rb_define_method( cPort, "port_up?", port_up, 0 );
+  rb_define_method( cPort, "port_down?", port_down, 0 );
+  rb_define_method( cPort, "link_up?", link_up, 0 );
+  rb_define_method( cPort, "link_down?", link_down, 0 );
+  rb_define_method( cPort, "up?", port_and_link_up, 0 );
+  rb_define_method( cPort, "down?", port_or_link_down, 0 );
   rb_define_method( cPort, "<=>", port_compare, 1 );
 }