trema 0.2.2.1 → 0.2.3

data/ruby/trema/stats-request.c

@@ -24,6 +24,7 @@
 
 extern VALUE mTrema;
 VALUE cStatsRequest;
+VALUE cDescStatsRequest;
 VALUE cFlowStatsRequest;
 VALUE cAggregateStatsRequest;
 VALUE cTableStatsRequest;
@@ -119,6 +120,13 @@ subclass_stats_request_init( VALUE self, VALUE options ) {
 }
 
 
+static VALUE
+desc_stats_request_alloc( VALUE klass ) {
+  buffer *desc_stats_request = create_desc_stats_request( MY_TRANSACTION_ID, NO_FLAGS );
+  return Data_Wrap_Struct( klass, NULL, free_buffer, desc_stats_request );
+}
+
+
 static VALUE 
 flow_stats_request_alloc( VALUE klass ) {
   buffer *flow_stats_request = create_flow_stats_request( MY_TRANSACTION_ID, NO_FLAGS, MATCH, TABLE_ID, OUT_PORT );
@@ -226,7 +234,7 @@ stats_out_port( VALUE self ) {
 /*
  * Restrict port statistics to a specific port_no or to all ports.
  *
- * @return [Number] the value of port_no.
+  @return [Number] the value of port_no.
  */
 static VALUE
 stats_port_no( VALUE self ) {
@@ -274,11 +282,47 @@ get_stats_request_table_id( VALUE self ) {
 }
 
 
-struct ofp_match
-get_stats_request_match( VALUE self ) {
-  const struct ofp_match *match;
-  Data_Get_Struct( rb_iv_get( self, "@match" ), struct ofp_match, match );
-  return *match;
+static VALUE
+parse_common_arguments( int argc, VALUE *argv, VALUE self ) {
+  VALUE options;
+  if ( !rb_scan_args( argc, argv, "01", &options )) {
+    options = rb_hash_new();
+  }
+  rb_call_super( 1, &options );
+  buffer *message;
+  Data_Get_Struct( self, buffer, message );
+  ( ( struct ofp_header * ) ( message->data ) )->xid = htonl( get_stats_request_num2uint( self, "@transaction_id" ) );
+  struct ofp_stats_request *stats_request;
+  stats_request = ( struct ofp_stats_request * ) message->data;
+  stats_request->flags = htons ( get_stats_request_num2uint16( self, "@flags" ) );
+  return self;
+}
+
+
+/*
+ * A {DescStatsRequest} object instance to request descriptive information of vswitch.
+ * Such information includes switch manufacturer, hardware revision and serial number
+ *
+ * @overload initialize(options={})
+ *
+ *   @example 
+ *     DescStatsRequest.new(
+ *       :transaction_id => 1234
+ *     )
+ *
+ *   @param [Hash] options
+ *     the options to create a message with.
+ *
+ *   @option options [Number] :transaction_id
+ *     set the transaction_id as specified or auto-generate it.
+ *
+ *   @return [TableStatsRequest]
+ *     an object that encapsulates the +OFPT_STATS_REQUEST(OFPST_DSST)+ openflow
+ *     message.
+ */
+static VALUE
+desc_stats_request_init( int argc, VALUE *argv, VALUE self ) {
+  return parse_common_arguments( argc, argv, self );
 }
 
 
@@ -327,8 +371,9 @@ flow_stats_request_init( VALUE self, VALUE options ) {
 
   stats_request->flags = htons ( get_stats_request_num2uint16( self, "@flags" ) );
 
-  struct ofp_match m = get_stats_request_match( self );
-  hton_match( &flow_stats_request->match, &m  ) ;
+  const struct ofp_match *match;
+  Data_Get_Struct( rb_iv_get( self, "@match" ), struct ofp_match, match );
+  hton_match( &flow_stats_request->match, match );
   flow_stats_request->table_id = get_stats_request_table_id( self );
   flow_stats_request->out_port = htons( get_stats_request_num2uint16( self, "@out_port" ) );
   return self;
@@ -379,8 +424,9 @@ aggregate_stats_request_init( VALUE self, VALUE options ) {
 
   stats_request->flags = htons ( get_stats_request_num2uint16( self, "@flags" ) );
 
-  struct ofp_match m = get_stats_request_match( self );
-  hton_match( &aggregate_stats_request->match, &m  ) ;
+  const struct ofp_match *match;
+  Data_Get_Struct( rb_iv_get( self, "@match" ), struct ofp_match, match );
+  hton_match( &aggregate_stats_request->match, match );
   aggregate_stats_request->table_id = get_stats_request_table_id( self );
   aggregate_stats_request->out_port = htons( get_stats_request_num2uint16( self, "@out_port" ) );
   return self;
@@ -411,18 +457,7 @@ aggregate_stats_request_init( VALUE self, VALUE options ) {
  */
 static VALUE
 table_stats_request_init( int argc, VALUE *argv, VALUE self ) {
-  VALUE options;
-  if ( !rb_scan_args( argc, argv, "01", &options )) {
-    options = rb_hash_new();
-  }
-  rb_call_super( 1, &options );
-  buffer *message;
-  Data_Get_Struct( self, buffer, message );
-  ( ( struct ofp_header * ) ( message->data ) )->xid = htonl( get_stats_request_num2uint( self, "@transaction_id" ) );
-  struct ofp_stats_request *stats_request;
-  stats_request = ( struct ofp_stats_request * ) message->data;
-  stats_request->flags = htons ( get_stats_request_num2uint16( self, "@flags" ) );
-  return self;
+  return parse_common_arguments( argc, argv, self );
 }
 
 
@@ -586,11 +621,17 @@ vendor_stats_request_init( int argc, VALUE *argv, VALUE self ) {
 void
 Init_stats_request(){
   cStatsRequest = rb_define_class_under( mTrema, "StatsRequest", rb_cObject );
+
+  cDescStatsRequest = rb_define_class_under( mTrema, "DescStatsRequest", cStatsRequest );
+  rb_define_alloc_func( cDescStatsRequest, desc_stats_request_alloc );
+  rb_define_method( cDescStatsRequest, "initialize", desc_stats_request_init, -1 );
+
   cFlowStatsRequest = rb_define_class_under( mTrema, "FlowStatsRequest", cStatsRequest );
   rb_define_method( cStatsRequest, "initialize", stats_request_init, 1 );
   rb_define_method( cStatsRequest, "transaction_id", stats_transaction_id, 0 );
+  rb_alias( cStatsRequest, rb_intern( "xid" ), rb_intern( "transaction_id" ) );
   rb_define_method( cStatsRequest, "flags", stats_flags, 0 );
-  
+
   rb_define_alloc_func( cFlowStatsRequest, flow_stats_request_alloc );
   rb_define_method( cFlowStatsRequest, "initialize", flow_stats_request_init, 1 );
   rb_define_method( cFlowStatsRequest, "match", stats_match, 0 );

data/ruby/trema/strip-vlan-header.rb

@@ -0,0 +1,41 @@
+#
+# 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"
+
+
+module Trema
+  #
+  # Strips the VLAN tag of a packet.
+  #
+  class StripVlanHeader < Action
+    #
+    # Creates an action that strips the VLAN tag of a packet.
+    #
+    def initialize
+      # Do nothing.
+    end
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/ruby/trema/switch.c

@@ -0,0 +1,196 @@
+/*
+ * 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 "chibach.h"
+#include "flow-mod.h"
+#include "logger.h"
+#include "ruby.h"
+#include "rubysig.h"
+#include "switch.h"
+
+
+VALUE mTrema;
+VALUE cSwitch;
+
+
+static VALUE
+switch_send_message( VALUE self, VALUE message ) {
+  buffer *buf;
+  Data_Get_Struct( message, buffer, buf );
+  switch_send_openflow_message( buf );
+  return self;
+}
+
+
+static void
+handle_controller_connected( void *rbswitch ) {
+  if ( rb_respond_to( ( VALUE ) rbswitch, rb_intern( "controller_connected" ) ) == Qtrue ) {
+    rb_funcall( ( VALUE ) rbswitch, rb_intern( "controller_connected" ), 0 );
+  }
+}
+
+
+static void
+handle_hello( uint32_t transaction_id, uint8_t version, void *rbswitch ) {
+  if ( rb_respond_to( ( VALUE ) rbswitch, rb_intern( "hello" ) ) == Qtrue ) {
+    rb_funcall( ( VALUE ) rbswitch, rb_intern( "hello" ), 2, UINT2NUM( transaction_id ), UINT2NUM( version ) );
+  }
+}
+
+
+static void
+handle_features_request( uint32_t transaction_id, void *rbswitch ) {
+  if ( rb_respond_to( ( VALUE ) rbswitch, rb_intern( "features_request" ) ) == Qtrue ) {
+    rb_funcall( ( VALUE ) rbswitch, rb_intern( "features_request" ), 1, UINT2NUM( transaction_id ) );
+  }
+}
+
+
+static void
+handle_set_config( uint32_t transaction_id, uint16_t flags, uint16_t miss_send_len, void *rbswitch ) {
+  if ( rb_respond_to( ( VALUE ) rbswitch, rb_intern( "set_config" ) ) == Qtrue ) {
+    rb_funcall( ( VALUE ) rbswitch, rb_intern( "set_config" ), 3, UINT2NUM( transaction_id ), UINT2NUM( flags ), UINT2NUM( miss_send_len ) );
+  }
+}
+
+
+static void
+handle_flow_mod(
+  uint32_t transaction_id,
+  struct ofp_match match,
+  uint64_t cookie,
+  uint16_t command,
+  uint16_t idle_timeout,
+  uint16_t hard_timeout,
+  uint16_t priority,
+  uint32_t buffer_id,
+  uint16_t out_port,
+  uint16_t flags,
+  const openflow_actions *actions,
+  void *rbswitch
+){
+  UNUSED( match );
+  UNUSED( cookie );
+  UNUSED( priority );
+  UNUSED( buffer_id );
+  UNUSED( out_port );
+  UNUSED( flags );
+  UNUSED( actions );
+  if ( rb_respond_to( ( VALUE ) rbswitch, rb_intern( "flow_mod" ) ) == Qtrue ) {
+    VALUE options = rb_hash_new();
+    rb_hash_aset( options, ID2SYM( rb_intern( "transaction_id" ) ), UINT2NUM( transaction_id ) );
+    rb_hash_aset( options, ID2SYM( rb_intern( "command" ) ), UINT2NUM( command ) );
+    rb_hash_aset( options, ID2SYM( rb_intern( "idle_timeout" ) ), UINT2NUM( idle_timeout ) );
+    rb_hash_aset( options, ID2SYM( rb_intern( "hard_timeout" ) ), UINT2NUM( hard_timeout ) );
+    VALUE flow_mod = rb_funcall( cFlowMod, rb_intern( "new" ), 1, options );
+    rb_funcall( ( VALUE ) rbswitch, rb_intern( "flow_mod" ), 2, UINT2NUM( transaction_id ), flow_mod );
+  }
+}
+
+
+static void
+handle_echo_request( uint32_t transaction_id, const buffer *body, void *rbswitch ) {
+  if ( rb_respond_to( ( VALUE ) rbswitch, rb_intern( "echo_request" ) ) == Qtrue ) {
+    VALUE rbody = rb_str_new( body->data, ( long ) body->length );
+    rb_funcall( ( VALUE ) rbswitch, rb_intern( "echo_request" ), 2, UINT2NUM( transaction_id ), rbody );
+  }
+}
+
+
+static VALUE
+switch_run( VALUE self ) {
+  setenv( "CHIBACH_HOME", STR2CSTR( rb_funcall( mTrema, rb_intern( "home" ), 0 ) ), 1 );
+
+  VALUE name = rb_funcall( self, rb_intern( "name" ), 0 );
+  rb_gv_set( "$PROGRAM_NAME", name );
+
+  int argc = 6;
+  char **argv = xmalloc( sizeof( char * ) * ( uint32_t ) ( argc + 1 ) );
+  argv[ 0 ] = STR2CSTR( name );
+  argv[ 1 ] = ( char * ) ( uintptr_t ) "--name";
+  argv[ 2 ] = STR2CSTR( name );
+  argv[ 3 ] = ( char * ) ( uintptr_t ) "--datapath_id";
+  argv[ 4 ] = STR2CSTR( rb_funcall( rb_iv_get( self, "@dpid" ), rb_intern( "to_hex" ), 0 ) );
+  argv[ 5 ] = ( char * ) ( uintptr_t ) "--daemonize";
+  argv[ 6 ] = NULL;
+  init_chibach( &argc, &argv );
+  xfree( argv );
+
+  set_controller_connected_handler( handle_controller_connected, ( void * ) self );
+  set_hello_handler( handle_hello, ( void * ) self );
+  set_features_request_handler( handle_features_request, ( void * ) self );
+  set_set_config_handler( handle_set_config, ( void * ) self );
+  set_flow_mod_handler( handle_flow_mod, ( void * ) self );
+  set_echo_request_handler( handle_echo_request, ( void * ) self );
+
+  if ( rb_respond_to( self, rb_intern( "start" ) ) == Qtrue ) {
+    rb_funcall( self, rb_intern( "start" ), 0 );
+  }
+
+  rb_funcall( self, rb_intern( "start_chibach" ), 0 );
+
+  return self;
+}
+
+
+static void
+thread_pass( void *user_data ) {
+  UNUSED( user_data );
+  CHECK_INTS;
+  rb_funcall( rb_cThread, rb_intern( "pass" ), 0 );
+}
+
+
+static VALUE
+switch_start_chibach( VALUE self ) {
+  struct itimerspec interval;
+  interval.it_interval.tv_sec = 0;
+  interval.it_interval.tv_nsec = 1000000;
+  interval.it_value.tv_sec = 0;
+  interval.it_value.tv_nsec = 0;
+  add_timer_event_callback( &interval, thread_pass, NULL );
+
+  start_chibach();
+
+  return self;
+}
+
+
+/********************************************************************************
+ * Init Switch module.
+ ********************************************************************************/
+
+void
+Init_switch() {
+  cSwitch = rb_define_class_under( mTrema, "Switch", rb_cObject );
+  rb_include_module( cSwitch, mLogger );
+
+  rb_define_method( cSwitch, "run!", switch_run, 0 );
+  rb_define_method( cSwitch, "send_message", switch_send_message, 1 );
+  rb_define_private_method( cSwitch, "start_chibach", switch_start_chibach, 0 );
+
+  rb_require( "trema/switch" );
+}
+
+
+/*
+ * Local variables:
+ * c-basic-offset: 2
+ * indent-tabs-mode: nil
+ * End:
+ */

data/ruby/trema/{action-vendor.h → switch.h}

@@ -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,20 +16,20 @@
  */
 
 
-#ifndef ACTION_VENDOR_H
-#define ACTION_VENDOR_H
+#ifndef SWITCH_H
+#define SWITCH_H
 
 
 #include "ruby.h"
 
 
-extern VALUE cActionVendor;
+extern VALUE cSwitch;
 
 
-void Init_action_vendor( void );
+void Init_switch( void );
 
 
-#endif // ACTION_VENDOR_H
+#endif // SWITCH_H
 
 
 /*

data/ruby/trema/switch.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
@@ -18,20 +16,41 @@
 #
 
 
-require "trema/network-component"
+module Trema
+  class Switch
+    attr_reader :dpid
+    alias :datapath_id :dpid
 
 
-module Trema
-  #
-  # Keeps a list of {OpenflowSwitch} and {OpenVswitch}
-  #
-  class Switch < NetworkComponent
+    def self.inherited subclass
+      at_exit { subclass.new( eval ARGV[ 0 ] ).run! }
+    end
+
+
+    def initialize dpid
+      @dpid = dpid
+    end
+
+
+    def name
+      self.class.to_s.split( "::" ).last
+    end
+
+
+    def controller_connected
+      send_message Hello.new
+    end
+
+
+    def features_request xid
+      send_message FeaturesReply.new( :datapath_id => @dpid, :transaction_id => xid )
+    end
   end
 end
 
 
 ### Local variables:
 ### mode: Ruby
-### coding: utf-8-unix
+### coding: utf-8
 ### indent-tabs-mode: nil
 ### End: