trema 0.2.2.1 → 0.2.3

data/ruby/trema/error.h

@@ -1,8 +1,6 @@
 /*
  * Ruby wrapper class for OFPT_ERROR message.
  *
- * Author: Nick Karanatsios <nickkaranatsios@gmail.com>
- *
  * Copyright (C) 2008-2012 NEC Corporation
  *
  * This program is free software; you can redistribute it and/or modify

data/ruby/trema/features-reply.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
@@ -28,56 +26,101 @@ extern VALUE mTrema;
 VALUE cFeaturesReply;
 
 
-/* 
- * A user would not explicitly instantiate a {FeaturesReply} object but would be 
- * created while parsing the +OFPT_FEATURES_REPLY+ message.
+static VALUE
+features_reply_alloc( VALUE klass ) {
+  buffer *features_reply = create_features_reply( 0, 0, 0, 0, 0, 0, NULL );
+  return Data_Wrap_Struct( klass, NULL, free_buffer, features_reply );
+}
+
+
+/*
+ * Creates a FeaturesReply message. A user would not explicitly
+ * instantiate a {FeaturesReply} object but would be created while
+ * parsing the +OFPT_FEATURES_REPLY+ message.
  *
- * @overload initialize(options={})
+ * @overload initialize(options)
  *   @example
- *     FeaturesReply.new( 
+ *     FeaturesReply.new(
  *       :datapath_id => 0xabc,
  *       :transaction_id => 1,
  *       :n_buffers => 256,
  *       :n_tables => 1,
  *       :capabilities => 135,
  *       :actions => 2048,
- *       :port => [ Trema::Port ]
+ *       :port => [ port1, port2, ... ]
  *     )
- *
  *   @param [Hash] options
  *     the options to create a message with.
- *
  *   @option options [Number] :datapath_id
- *     datapath unique id. Subsequent commands directed to switch should 
+ *     datapath unique id. Subsequent commands directed to switch should
  *     embed this id.
- *
  *   @option options [Number] :transaction_id
  *     a positive number lower layers match this to ensure message integrity.
- *
  *   @option options [Number] :n_buffers
  *     maximum number of packets that can be buffered at once.
- *
  *   @option options [Number] :n_tables
- *     number of supported tables, number could vary according to 
+ *     number of supported tables, number could vary according to
  *     switch's implementation.
- *
  *   @option options [Number] :capabilities
- *     supported capabilities expressed as a 32-bit bitmap. Ability of a switch 
- *     to respond or perform a certain function for example flow statistics, 
+ *     supported capabilities expressed as a 32-bit bitmap. Ability of a switch
+ *     to respond or perform a certain function for example flow statistics,
  *     IP address lookup in APR packets.
- *
  *   @option options [Number] :actions
  *     supported actions expressed as a 32-bit bitmap.
- *
  *   @option options [Port] :port
  *     an array of {Port} objects detailing physical port description and function.
- *
  *   @return [FeaturesReply]
- *     an object that encapsulates the +OFPT_FEATURES_REPLY+ OpenFlow message.
  */
 static VALUE
 features_reply_init( VALUE self, VALUE options ) {
+  buffer *buf = NULL;
+  Data_Get_Struct( self, buffer, buf );
+  struct ofp_switch_features *features_reply = buf->data;
+  VALUE tmp = Qnil;
+
+  tmp = rb_hash_aref( options, ID2SYM( rb_intern( "datapath_id" ) ) );
+  if ( tmp == Qnil ) {
+    rb_raise( rb_eArgError, ":datapath_id is a mandatory option" );
+  }
+  features_reply->datapath_id = htonll( NUM2ULL( tmp ) );
+
+  tmp = rb_hash_aref( options, ID2SYM( rb_intern( "transaction_id" ) ) );
+  if ( tmp == Qnil ) {
+    tmp = rb_hash_aref( options, ID2SYM( rb_intern( "xid" ) ) );
+    if ( tmp == Qnil ) {
+      rb_raise( rb_eArgError, ":transaction_id is a mandatory option" );
+    }
+  }
+  features_reply->header.xid = htonl( NUM2UINT( tmp ) );
+
+  features_reply->n_buffers = 0;
+  tmp = rb_hash_aref( options, ID2SYM( rb_intern( "n_buffers" ) ) );
+  if ( tmp != Qnil ) {
+    features_reply->n_buffers = htonl( NUM2UINT( tmp ) );
+  }
+
+  features_reply->n_tables = 1;
+  tmp = rb_hash_aref( options, ID2SYM( rb_intern( "n_tables" ) ) );
+  if ( tmp != Qnil ) {
+    features_reply->n_tables = ( uint8_t ) NUM2UINT( tmp );
+  }
+
+  features_reply->capabilities = 0;
+  tmp = rb_hash_aref( options, ID2SYM( rb_intern( "capabilities" ) ) );
+  if ( tmp != Qnil ) {
+    features_reply->capabilities = htonl( NUM2UINT( tmp ) );
+  }
+
+  features_reply->actions = htonl( 1 << OFPAT_OUTPUT );
+  tmp = rb_hash_aref( options, ID2SYM( rb_intern( "actions" ) ) );
+  if ( tmp != Qnil ) {
+    features_reply->actions = htonl( NUM2UINT( tmp ) );
+  }
+
+  // TODO: ports
+
   rb_iv_set( self, "@attribute", options );
+
   return self;
 }
 
@@ -100,7 +143,18 @@ features_reply_datapath_id( VALUE self ) {
  */
 static VALUE
 features_reply_transaction_id( VALUE self ) {
-  return rb_hash_aref( rb_iv_get( self, "@attribute" ), ID2SYM( rb_intern( "transaction_id" ) ) );
+  VALUE xid = Qnil;
+
+  xid = rb_hash_aref( rb_iv_get( self, "@attribute" ), ID2SYM( rb_intern( "transaction_id" ) ) );
+  if ( xid != Qnil ) {
+    return xid;
+  }
+  xid = rb_hash_aref( rb_iv_get( self, "@attribute" ), ID2SYM( rb_intern( "xid" ) ) );
+  if ( xid != Qnil ) {
+    return xid;
+  }
+
+  return Qnil;
 }
 
 
@@ -162,9 +216,11 @@ features_reply_ports( VALUE self ) {
 void
 Init_features_reply() {
   cFeaturesReply = rb_define_class_under( mTrema, "FeaturesReply", rb_cObject );
+  rb_define_alloc_func( cFeaturesReply, features_reply_alloc );
   rb_define_method( cFeaturesReply, "initialize", features_reply_init, 1 );
   rb_define_method( cFeaturesReply, "datapath_id", features_reply_datapath_id, 0 );
   rb_define_method( cFeaturesReply, "transaction_id", features_reply_transaction_id, 0 );
+  rb_alias( cFeaturesReply, rb_intern( "xid" ), rb_intern( "transaction_id" ) );
   rb_define_method( cFeaturesReply, "n_buffers", features_reply_n_buffers, 0 );
   rb_define_method( cFeaturesReply, "n_tables", features_reply_n_tables, 0 );
   rb_define_method( cFeaturesReply, "capabilities", features_reply_capabilities, 0 );
@@ -173,13 +229,21 @@ Init_features_reply() {
 }
 
 
+void
+handle_switch_ready( uint64_t datapath_id, void *controller ) {
+  if ( rb_respond_to( ( VALUE ) controller, rb_intern( "switch_ready" ) ) == Qtrue ) {
+    rb_funcall( ( VALUE ) controller, rb_intern( "switch_ready" ), 1, ULL2NUM( datapath_id ) );
+  }
+}
+
+
 /*
  * Extract and map {Port} to +ofp_phy_port+ structure.
  */
 static VALUE
 ports_from( const list_element *phy_ports ) {
   VALUE ports = rb_ary_new();
-  
+
   list_element *port_head = xmalloc( sizeof( list_element ) );
   memcpy( port_head, phy_ports, sizeof( list_element ) );
   list_element *port = NULL;
@@ -191,16 +255,6 @@ ports_from( const list_element *phy_ports ) {
 }
 
 
-void
-handle_switch_ready( uint64_t datapath_id, void *controller ) {
-  if ( rb_respond_to( ( VALUE ) controller, rb_intern( "switch_ready" ) ) == Qtrue ) {
-    rb_funcall( ( VALUE ) controller, rb_intern( "switch_ready" ), 1, ULL2NUM( datapath_id ) );
-  }
-}
-
-/*
- * The handler that is called when an +OFPT_FEATURES_REPLY+ message is received.
- */
 void
 handle_features_reply(
   uint64_t datapath_id,
@@ -226,7 +280,7 @@ handle_features_reply(
   rb_hash_aset( attributes, ID2SYM( rb_intern( "ports" ) ), ports_from( phy_ports ) );
 
   VALUE features_reply = rb_funcall( cFeaturesReply, rb_intern( "new" ), 1, attributes );
-  rb_funcall( ( VALUE ) controller, rb_intern( "features_reply" ), 1, features_reply );
+  rb_funcall( ( VALUE ) controller, rb_intern( "features_reply" ), 2, ULL2NUM( datapath_id ), features_reply );
 }
 
 

data/ruby/trema/features-reply.h

@@ -1,8 +1,6 @@
 /*
  * Ruby wrapper class of OpenFlow features reply 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
@@ -32,11 +30,7 @@ extern VALUE cFeaturesReply;
 
 
 void Init_features_reply( void );
-
-
 void handle_switch_ready( uint64_t datapath_id, void *controller );
-
-
 void handle_features_reply(
   uint64_t datapath_id,
   uint32_t transaction_id,

data/ruby/trema/features-request.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-ruby-utils.h"
+#include "trema.h"
 
 
 extern VALUE mTrema;
@@ -33,62 +32,88 @@ features_request_alloc( VALUE klass ) {
 }
 
 
-/* 
- * A features request message is sent upon TLS session establishment to obtain 
- * switch's supported capabilities. Creates an object that encapsulates the
- * +OFPT_FEATURES_REQUEST+ OpenFlow message.
+/*
+ * Creates a FeaturesRequest OpenFlow message.
  *
- * @overload initialize(options={})
+ * @overload initialize()
  *   @example
- *     FeaturesRequeset.new
- *     FeaturesRequest.new( :transaction_id => 123 )
+ *     FeaturesRequest.new
  *
+ * @overload initialize(transaction_id)
+ *   @example
+ *     FeaturesRequest.new( 123 )
+ *   @param [Integer] transaction_id
+ *     An unsigned 32bit integer number associated with this message.
+ *
+ * @overload initialize(options)
+ *   @example
+ *     FeaturesRequest.new( :xid => 123 )
+ *     FeaturesRequest.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.
  *
- *   @option options [Symbol] :transaction_id
- *     any positive number, same value should be attached to the +OFPT_FEATURES_REPLY+  
- *     message. If not specified is auto-generated.
- *
- *   @raise [ArgumentError] if transaction id is not an unsigned 32-bit integer.
- *   @raise [TypeError] if options is not a hash.
- *
- *   @return [FeaturesRequest] 
- *     an object that encapsulates the +OFPT_FEATURES_REQUEST+ 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 [FeaturesRequest]
  */
 static VALUE
 features_request_init( int argc, VALUE *argv, VALUE self ) {
-  buffer *features_request;
+  buffer *features_request = NULL;
   Data_Get_Struct( self, buffer, features_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( features_request, get_transaction_id() );
+  }
+  else {
+    if ( options == Qnil ) {
+      set_xid( features_request, get_transaction_id() );
+    }
+    else if ( rb_obj_is_kind_of( options, rb_cInteger ) == Qtrue ) {
+      validate_xid( options );
+      set_xid( features_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( features_request, ( uint32_t ) NUM2UINT( xid ) );
+      }
+      else {
+        set_xid( features_request, get_transaction_id() );
       }
-      xid = ( uint32_t ) NUM2UINT( xid_ruby );
     }
   }
-  ( ( struct ofp_header * ) ( features_request->data ) )->xid = htonl( xid );
+
   return self;
 }
 
 
 /*
- * Transaction ids, message sequence numbers matching requests to replies.
+ * Transaction ids, message sequence numbers matching requests to
+ * replies.
  *
- * @return [Number] the value of transaction id.
+ * @return [Number] the value of transaction ID.
  */
 static VALUE
 features_request_transaction_id( VALUE self ) {
-  buffer *features_request;
-  Data_Get_Struct( self, buffer, features_request );
-  uint32_t xid = ntohl( ( ( struct ofp_header * ) ( features_request->data ) )->xid );
-  return UINT2NUM( xid );
+  return get_xid( self );
 }
 
 
@@ -98,6 +123,7 @@ Init_features_request() {
   rb_define_alloc_func( cFeaturesRequest, features_request_alloc );
   rb_define_method( cFeaturesRequest, "initialize", features_request_init, -1 );
   rb_define_method( cFeaturesRequest, "transaction_id", features_request_transaction_id, 0 );
+  rb_alias( cFeaturesRequest, rb_intern( "xid" ), rb_intern( "transaction_id" ) );
 }
 
 

data/ruby/trema/features-request.h

@@ -1,8 +1,6 @@
 /*
  * Ruby wrapper class of OpenFlow features request 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/flow-mod.c

@@ -0,0 +1,149 @@
+/*
+ * 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.
+ */
+
+
+#include "ruby.h"
+#include "trema.h"
+#include "trema-ruby-utils.h"
+
+
+extern VALUE mTrema;
+VALUE cFlowMod;
+
+
+static VALUE
+flow_mod_alloc( VALUE klass ) {
+  struct ofp_match match;
+  buffer *flow_mod = create_flow_mod(
+    0,
+    match,
+    0,
+    0,
+    0,
+    0,
+    UINT16_MAX,
+    UINT32_MAX,
+    OFPP_NONE,
+    0,
+    NULL
+  );
+  return Data_Wrap_Struct( klass, NULL, free_buffer, flow_mod );
+}
+
+
+static VALUE
+flow_mod_init( int argc, VALUE *argv, VALUE self ) {
+  buffer *flow_mod = NULL;
+  Data_Get_Struct( self, buffer, flow_mod );
+  VALUE options = Qnil;
+
+  if ( rb_scan_args( argc, argv, "01", &options ) == 0 ) {
+    set_xid( flow_mod, get_transaction_id() );
+  }
+  else {
+    if ( options == Qnil ) {
+      set_xid( flow_mod, get_transaction_id() );
+    }
+    else if ( rb_obj_is_kind_of( options, rb_cInteger ) == Qtrue ) {
+      validate_xid( options );
+      set_xid( flow_mod, ( 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;
+      }
+
+      tmp = rb_hash_aref( options, ID2SYM( rb_intern( "idle_timeout" ) ) );
+      if ( tmp != Qnil ) {
+        ( ( struct ofp_flow_mod * ) ( flow_mod->data ) )->idle_timeout = ( uint16_t ) NUM2UINT( tmp );
+      }
+
+      if ( xid != Qnil ) {
+        validate_xid( xid );
+        set_xid( flow_mod, ( uint32_t ) NUM2UINT( xid ) );
+      }
+      else {
+        set_xid( flow_mod, get_transaction_id() );
+      }
+    }
+  }
+
+  return self;
+}
+
+
+static VALUE
+flow_mod_transaction_id( VALUE self ) {
+  return get_xid( self );
+}
+
+
+static VALUE
+flow_mod_command( VALUE self ) {
+  buffer *flow_mod;
+  Data_Get_Struct( self, buffer, flow_mod );
+  uint32_t command = ntohl( ( ( struct ofp_flow_mod * ) ( flow_mod->data ) )->command );
+  return UINT2NUM( command );
+}
+
+
+static VALUE
+flow_mod_idle_timeout( VALUE self ) {
+  buffer *flow_mod;
+  Data_Get_Struct( self, buffer, flow_mod );
+  uint32_t idle_timeout = ntohl( ( ( struct ofp_flow_mod * ) ( flow_mod->data ) )->idle_timeout );
+  return UINT2NUM( idle_timeout );
+}
+
+
+static VALUE
+flow_mod_hard_timeout( VALUE self ) {
+  buffer *flow_mod;
+  Data_Get_Struct( self, buffer, flow_mod );
+  uint32_t hard_timeout = ntohl( ( ( struct ofp_flow_mod * ) ( flow_mod->data ) )->hard_timeout );
+  return UINT2NUM( hard_timeout );
+}
+
+
+void
+Init_flow_mod() {
+  cFlowMod = rb_define_class_under( mTrema, "FlowMod", rb_cObject );
+  rb_define_alloc_func( cFlowMod, flow_mod_alloc );
+  rb_define_method( cFlowMod, "initialize", flow_mod_init, -1 );
+  rb_define_method( cFlowMod, "transaction_id", flow_mod_transaction_id, 0 );
+  rb_define_method( cFlowMod, "command", flow_mod_command, 0 );
+  rb_define_method( cFlowMod, "idle_timeout", flow_mod_idle_timeout, 0 );
+  rb_define_method( cFlowMod, "hard_timeout", flow_mod_hard_timeout, 0 );
+  rb_alias( cFlowMod, rb_intern( "xid" ), rb_intern( "transaction_id" ) );
+}
+
+
+/*
+ * Local variables:
+ * c-basic-offset: 2
+ * indent-tabs-mode: nil
+ * End:
+ */