trema 0.2.2.1 → 0.2.3

data/ruby/trema/trema-ruby-utils.c

@@ -0,0 +1,66 @@
+/*
+ * 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"
+
+
+void
+set_xid( const buffer *openflow_message, uint32_t xid ) {
+  ( ( struct ofp_header * ) ( openflow_message->data ) )->xid = htonl( xid );
+}
+
+
+VALUE
+get_xid( VALUE self ) {
+  buffer *openflow_message;
+  Data_Get_Struct( self, buffer, openflow_message );
+  uint32_t xid = ntohl( ( ( struct ofp_header * ) ( openflow_message->data ) )->xid );
+  return UINT2NUM( xid );
+}
+
+
+void
+set_length( const buffer *openflow_message, uint16_t length ) {
+  ( ( struct ofp_header * ) ( openflow_message->data ) )->length = htons( ( uint16_t ) ( sizeof( struct ofp_header ) + length ) );
+}
+
+
+uint16_t
+get_length( const buffer *openflow_message ) {
+  return ( uint16_t ) ( openflow_message->length - sizeof( struct ofp_vendor_header ) );
+}
+
+
+void
+validate_xid( VALUE xid ) {
+  if ( rb_obj_is_kind_of( xid, rb_cInteger ) != Qtrue ) {
+    rb_raise( rb_eTypeError, "Transaction ID must be an integer" );
+  }
+  if ( rb_funcall( xid, rb_intern( "unsigned_32bit?" ), 0 ) == Qfalse ) {
+    rb_raise( rb_eArgError, "Transaction ID must be an unsigned 32-bit integer" );
+  }
+}
+
+
+/*
+ * Local variables:
+ * c-basic-offset: 2
+ * indent-tabs-mode: nil
+ * End:
+ */

data/ruby/trema/{action-set-dl-src.h → trema-ruby-utils.h}

@@ -1,8 +1,4 @@
 /*
- * Prototype for setting the source data link address flow action.
- *
- * 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,20 +16,22 @@
  */
 
 
-#ifndef ACTION_SET_DL_SRC_H
-#define ACTION_SET_DL_SRC_H
+#ifndef TREMA_RUBY_UTILS_H
+#define TREMA_RUBY_UTILS_H
 
 
 #include "ruby.h"
+#include "trema.h"
 
 
-extern VALUE cActionSetDlSrc;
-
-
-void Init_action_set_dl_src( void );
+void set_xid( const buffer *openflow_message, uint32_t xid );
+VALUE get_xid( VALUE self );
+void set_length( const buffer *openflow_message, uint16_t length );
+uint16_t get_length( const buffer *openflow_message );
+void validate_xid( VALUE xid );
 
 
-#endif // ACTION_SET_DL_SRC_H
+#endif // TREMA_RUBY_UTILS_H
 
 
 /*

data/ruby/trema/trema.c

@@ -1,8 +1,6 @@
 /*
  * Ruby wrapper around libtrema.
  *
- * Author: Yasuhito Takamiya <yasuhito@gmail.com>
- *
  * Copyright (C) 2008-2012 NEC Corporation
  *
  * This program is free software; you can redistribute it and/or modify
@@ -20,45 +18,34 @@
  */
 
 
-#include "action-output.h"
+#include "barrier-reply.h"
+#include "barrier-request.h"
 #include "controller.h"
-#include "features-reply.h"
-#include "features-request.h"
-#include "set-config.h"
-#include "hello.h"
-#include "logger.h"
-#include "packet_in.h"
-#include "port.h"
-#include "action-set-dl-dst.h"
-#include "action-set-dl-src.h"
-#include "action-enqueue.h"
-#include "action-set-nw-src.h"
-#include "action-set-nw-dst.h"
-#include "action-set-tp-src.h"
-#include "action-set-tp-dst.h"
-#include "action-set-nw-tos.h"
-#include "action-set-vlan-vid.h"
-#include "action-set-vlan-pcp.h"
-#include "action-strip-vlan.h"
-#include "action-vendor.h"
-#include "echo-request.h"
 #include "echo-reply.h"
+#include "echo-request.h"
 #include "error.h"
-#include "stats-request.h"
+#include "features-reply.h"
+#include "features-request.h"
+#include "flow-mod.h"
 #include "flow-removed.h"
-#include "port-status.h"
-#include "stats-reply.h"
-#include "openflow-error.h"
 #include "get-config-reply.h"
 #include "get-config-request.h"
-#include "barrier-reply.h"
-#include "barrier-request.h"
-#include "vendor-request.h"
-#include "queue-get-config-request.h"
-#include "queue-get-config-reply.h"
-#include "port-mod.h"
+#include "hello.h"
+#include "logger.h"
 #include "match.h"
+#include "openflow-error.h"
+#include "packet-in.h"
+#include "port-mod.h"
+#include "port-status.h"
+#include "port.h"
+#include "queue-get-config-reply.h"
+#include "queue-get-config-request.h"
 #include "ruby.h"
+#include "set-config.h"
+#include "stats-reply.h"
+#include "stats-request.h"
+#include "switch.h"
+#include "vendor.h"
 
 
 VALUE mTrema;
@@ -68,48 +55,61 @@ void
 Init_trema() {
   mTrema = rb_define_module( "Trema" );
 
+  rb_define_const( mTrema, "OFPC_FLOW_STATS", INT2NUM( OFPC_FLOW_STATS ) );
+  rb_define_const( mTrema, "OFPC_TABLE_STATS", INT2NUM( OFPC_TABLE_STATS ) );
+  rb_define_const( mTrema, "OFPC_PORT_STATS", INT2NUM( OFPC_PORT_STATS ) );
+  rb_define_const( mTrema, "OFPC_STP", INT2NUM( OFPC_STP) );
+  rb_define_const( mTrema, "OFPC_RESERVED", INT2NUM( OFPC_RESERVED ) );
+  rb_define_const( mTrema, "OFPC_IP_REASM", INT2NUM( OFPC_IP_REASM ) );
+  rb_define_const( mTrema, "OFPC_QUEUE_STATS", INT2NUM( OFPC_QUEUE_STATS ) );
+  rb_define_const( mTrema, "OFPC_ARP_MATCH_IP", INT2NUM( OFPC_ARP_MATCH_IP ) );
+
+  rb_define_const( mTrema, "OFPAT_OUTPUT", INT2NUM( OFPAT_OUTPUT ) );
+  rb_define_const( mTrema, "OFPAT_SET_VLAN_VID", INT2NUM( OFPAT_SET_VLAN_VID ) );
+  rb_define_const( mTrema, "OFPAT_SET_VLAN_PCP", INT2NUM( OFPAT_SET_VLAN_PCP ) );
+  rb_define_const( mTrema, "OFPAT_STRIP_VLAN", INT2NUM( OFPAT_STRIP_VLAN ) );
+  rb_define_const( mTrema, "OFPAT_SET_DL_SRC", INT2NUM( OFPAT_SET_DL_SRC) );
+  rb_define_const( mTrema, "OFPAT_SET_DL_DST", INT2NUM( OFPAT_SET_DL_DST) );
+  rb_define_const( mTrema, "OFPAT_SET_NW_SRC", INT2NUM( OFPAT_SET_NW_SRC ) );
+  rb_define_const( mTrema, "OFPAT_SET_NW_DST", INT2NUM( OFPAT_SET_NW_DST ) );
+  rb_define_const( mTrema, "OFPAT_SET_NW_TOS", INT2NUM( OFPAT_SET_NW_TOS ) );
+  rb_define_const( mTrema, "OFPAT_SET_TP_SRC", INT2NUM( OFPAT_SET_TP_SRC ) );
+  rb_define_const( mTrema, "OFPAT_SET_TP_DST", INT2NUM( OFPAT_SET_TP_DST ) );
+  rb_define_const( mTrema, "OFPAT_ENQUEUE", INT2NUM( OFPAT_ENQUEUE ) );
+  rb_define_const( mTrema, "OFPAT_VENDOR", INT2NUM( OFPAT_VENDOR ) );
+
   rb_require( "trema/host" );
+  rb_require( "trema/openflow-switch" );
   rb_require( "trema/path" );
-  rb_require( "trema/switch" );
 
-  Init_action_output();
-  Init_action_set_dl_dst();
-  Init_action_set_dl_src();
-  Init_action_enqueue();
-  Init_action_set_nw_src();
-  Init_action_set_nw_dst();
-  Init_action_set_tp_src();
-  Init_action_set_tp_dst();
-  Init_action_set_nw_tos();
-  Init_action_set_vlan_vid();
-  Init_action_set_vlan_pcp();
-  Init_action_strip_vlan();
-  Init_action_vendor();
+  Init_barrier_reply();
+  Init_barrier_request();
+  Init_controller();
   Init_echo_reply();
   Init_echo_request();
   Init_error();
-  Init_logger();
-  Init_controller();
   Init_features_reply();
   Init_features_request();
-  Init_set_config();
-  Init_stats_request();
+  Init_flow_mod();
+  Init_flow_removed();
+  Init_get_config_reply();
+  Init_get_config_request();
   Init_hello();
+  Init_logger();
   Init_match();
+  Init_openflow_error();
   Init_packet_in();
   Init_port();
-  Init_flow_removed();
+  Init_port_mod();
   Init_port_status();
-  Init_stats_reply();
-  Init_openflow_error();
-  Init_get_config_request();
-  Init_get_config_reply();
-  Init_barrier_request();
-  Init_barrier_reply();
-  Init_queue_get_config_request();
   Init_queue_get_config_reply();
-  Init_vendor_request();
-  Init_port_mod();
+  Init_queue_get_config_request();
+  Init_set_config();
+  Init_stats_reply();
+  Init_stats_request();
+  Init_switch();
+  Init_vendor();
+
   rb_require( "trema/exact-match" );
 }
 

data/ruby/trema/vendor-action.rb

@@ -0,0 +1,73 @@
+#
+# 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/action"
+require "trema/monkey-patch/integer"
+
+
+module Trema
+  #
+  # An action to set vendor specific extensions.
+  #
+  class VendorAction < Action
+    attr_reader :body
+    attr_reader :vendor_id
+
+
+    #
+    # Creates an action to set vendor specific extensions.
+    #
+    # @example
+    #   VendorAction.new( 0x00004cff, "deadbeef".unpack( "C*" ) )
+    #
+    # @param [Integer] vendor_id
+    #   the vendor identifier. If MSB is zero low order bytes are IEEE
+    #   OUI. Otherwise defined by openflow.
+    # @param [Array] body
+    #   vendor-defined arbitrary additional data.
+    #
+    # @raise [TypeError] if vendor ID is not an Integer.
+    # @raise [ArgumentError] if vendor ID is not an unsigned 32-bit Integer.
+    # @raise [TypeError] if body is not an Array.
+    #
+    def initialize vendor_id, body = nil
+      if not vendor_id.is_a?( Integer )
+        raise TypeError, "Vendor ID must be an unsigned 32-bit integer"
+      end
+      if not vendor_id.unsigned_32bit?
+        raise ArgumentError, "Vendor ID must be an unsigned 32-bit integer"
+      end
+      if ( not body.nil? )  and ( not body.is_a?( Array ) )
+        raise TypeError, "Body must be an Array"
+      end
+        
+      @vendor_id = vendor_id
+      @body = body
+    end
+  end
+
+
+  ActionVendor = VendorAction
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/ruby/trema/vendor.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,103 +16,174 @@
  */
 
 
-#include "trema.h"
 #include "ruby.h"
+#include "trema-ruby-utils.h"
+#include "trema.h"
 
 
 extern VALUE mTrema;
 VALUE cVendor;
 
 
+static VALUE
+vendor_alloc( VALUE klass ) {
+  buffer *vendor = create_vendor( 0, 0, NULL );
+  return Data_Wrap_Struct( klass, NULL, free_buffer, vendor );
+}
+
+
 /*
- * Creates a {Vendor} instance that encapsulates the handling of vendor's messages.
+ * Creates a Vendor Reqeust message. This message can be used
+ * to facilitate sending of vendor-defined arbitrary data.
  *
- * @overload initialize(options={})
+ * @overload initialize
+ *   @example
+ *     Vendor.new
  *
- *   @example 
+ * @overload initialize(options)
+ *   @example
  *     Vendor.new(
- *       :datapath_id => 0xabc,
- *       :transaction_id => 123,
- *       :vendor => vendor_id,
- *       :buffer => data
+ *       :vendor => 0x3000,
+ *       :data => "deadbeef".unpack( "C*" ),
+ *       :transaction_id => 123
  *     )
  *
  *   @param [Hash] options
  *     the options to create a message with.
- *
- *   @option options [Number] :datapath_id
- *     message originator identifier.
- *
+ *   @option options [Number] :xid
  *   @option options [Number] :transaction_id
- *     zero for unsolicited message otherwise a positive number.
+ *     an unsigned 32bit integer number associated with this message.
+ *     if not specified, an auto-generated value is set.
+ *   @option options [Number] :vendor
+ *     the vendor identifier. If MSB is zero low order bytes are IEEE OUI. Otherwise defined by openflow.
+ *   @option options [Array] :data
+ *     a String that holds vendor's defined arbitrary length data.
  *
- *   @option options [Number] :vendor_id
- *     the vendor identifier. if MSB is zero low order bytes are IEEE OUI.
- *     If MSB not equal to zero defined by openflow.
- *
- *   @option options [String] :buffer
- *     a String that holds vendor's defined arbitrary length data. 
- *
- *   @return [Vendor]
- *     an object that encapsulates the +OFPT_VENDOR+ OpenFlow symmetric message.
+ * @raise [ArgumentError] if transaction ID is not an unsigned 32-bit integer.
+ * @raise [ArgumentError] if user data is not an array of bytes.
+ * @raise [TypeError] if options is not a hash.
+ * @return [Vendor]
  */
 static VALUE
-vendor_init( VALUE self, VALUE options ) {
-  rb_iv_set( self, "@attribute", options );
-  return self;
-}
+vendor_init( int argc, VALUE *argv, VALUE self ) {
+  buffer *vendor = NULL;
+  Data_Get_Struct( self, buffer, vendor );
+  VALUE options = Qnil;
 
-/*
- * Message originator identifier.
- *
- * @return [Number] the value of datapath_id.
- */
-static VALUE
-vendor_datapath_id( VALUE self ) {
-  return rb_hash_aref( rb_iv_get( self, "@attribute" ), ID2SYM( rb_intern( "datapath_id" ) ) );
+  if ( rb_scan_args( argc, argv, "01", &options ) == 0 ) {
+    set_xid( vendor, get_transaction_id() );
+  }
+  else {
+    if ( options == Qnil ) {
+      set_xid( vendor, get_transaction_id() );
+    }
+    else {
+      if ( rb_scan_args( argc, argv, "01", &options ) == 1 ) {
+        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( vendor, ( uint32_t ) NUM2UINT( xid ) );
+        }
+        else {
+          set_xid( vendor, get_transaction_id() );
+        }
+
+        tmp = rb_hash_aref( options, ID2SYM( rb_intern( "vendor" ) ) );
+        if ( tmp != Qnil ) {
+          ( ( struct ofp_vendor_header * ) ( vendor->data ) )->vendor = htonl( ( uint32_t ) NUM2UINT( tmp ) );
+        }
+
+        tmp = rb_hash_aref( options, ID2SYM( rb_intern( "data" ) ) );
+        if ( tmp != Qnil ) {
+          Check_Type( tmp, T_ARRAY );
+          uint16_t length = ( uint16_t ) RARRAY_LEN( tmp );
+          append_back_buffer( vendor, length );
+          set_length( vendor, length );
+          uint8_t *data = ( uint8_t * ) ( ( char * ) vendor->data + sizeof( struct ofp_vendor_header ) );
+          int i;
+          for ( i = 0; i < length; i++ ) {
+            data[ i ] = ( uint8_t ) FIX2INT( RARRAY_PTR( tmp )[ i ] );
+          }
+        }
+      }
+    }
+  }
+
+  return self;
 }
 
 
 /*
- * Zero for unsolicited message otherwise a positive number copied from request
- * message.
+ * 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
 vendor_transaction_id( VALUE self ) {
-  return rb_hash_aref( rb_iv_get( self, "@attribute" ), ID2SYM( rb_intern( "transaction_id" ) ) );
+  return get_xid( self );
 }
 
 
 /*
- * (see VendorRequest#vendor)
+ * A 32-bit value that uniquely identifies the vendor.
+ *
+ * @return [Number] the value of vendor id.
  */
 static VALUE
 vendor_vendor( VALUE self ) {
-  return rb_hash_aref( rb_iv_get( self, "@attribute" ), ID2SYM( rb_intern( "vendor" ) ) );
+  buffer *vendor_message;
+  Data_Get_Struct( self, buffer, vendor_message );
+  uint32_t vendor = ntohl( ( ( struct ofp_vendor_header * ) ( vendor_message->data ) )->vendor );
+  return UINT2NUM( vendor );
 }
 
 
 /*
- * Vendor's arbitrary length data.
+ * Vendor specific data payload.
  *
- * @return [Buffer] the value of buffer.
+ * @return [Array] an array of data payload bytes.
+ * @return [nil] vendor specific data not found.
  */
 static VALUE
-vendor_buffer( VALUE self ) {
-  return rb_hash_aref( rb_iv_get( self, "@attribute" ), ID2SYM( rb_intern( "buffer" ) ) );
+vendor_data( VALUE self ) {
+  buffer *vendor;
+  Data_Get_Struct( self, buffer, vendor );
+  uint16_t length = get_length( vendor );
+
+  if ( length > 0 ) {
+    VALUE data_array = rb_ary_new2( length );
+    uint8_t *data = ( uint8_t * ) ( ( char * ) vendor->data + sizeof( struct ofp_vendor_header ) );
+    int i;
+    for ( i = 0; i < length; i++ ) {
+      rb_ary_push( data_array, INT2FIX( data[ i ] ) );
+    }
+    return data_array;
+  }
+  return Qnil;
 }
 
 
 void
 Init_vendor() {
   cVendor = rb_define_class_under( mTrema, "Vendor", rb_cObject );
-  rb_define_method( cVendor, "initialize", vendor_init, 1 );
-  rb_define_method( cVendor, "datapath_id", vendor_datapath_id, 0 );
+  rb_define_alloc_func( cVendor, vendor_alloc );
+  rb_define_method( cVendor, "initialize", vendor_init, -1 );
   rb_define_method( cVendor, "transaction_id", vendor_transaction_id, 0 );
+  rb_alias( cVendor, rb_intern( "xid" ), rb_intern( "transaction_id" ) );
   rb_define_method( cVendor, "vendor", vendor_vendor, 0 );
-  rb_define_method( cVendor, "buffer", vendor_buffer, 0 );
+  rb_define_method( cVendor, "data", vendor_data, 0 );
 }
 
 
@@ -123,7 +192,7 @@ handle_vendor(
   uint64_t datapath_id,
   uint32_t transaction_id,
   uint32_t vendor,
-  buffer *body,
+  buffer *data,
   void *user_data
 ) {
   VALUE controller = ( VALUE ) user_data;
@@ -136,8 +205,8 @@ handle_vendor(
   rb_hash_aset( attributes, ID2SYM( rb_intern( "transaction_id" ) ), UINT2NUM( transaction_id ) );
   rb_hash_aset( attributes, ID2SYM( rb_intern( "vendor" ) ), UINT2NUM( vendor ) );
 
-  if ( body->length ) {
-    rb_hash_aset( attributes, ID2SYM( rb_intern( "buffer" ) ), rb_str_new( body->data, ( long ) body->length ) );
+  if ( data->length ) {
+    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 );