trema 0.1.3

data/ruby/trema/trema.c

@@ -0,0 +1,122 @@
+/*
+ * 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
+ * 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 "action-output.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 "error.h"
+#include "stats-request.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 "match.h"
+#include "ruby.h"
+
+
+VALUE mTrema;
+
+
+void
+Init_trema() {
+  mTrema = rb_define_module( "Trema" );
+
+  rb_require( "trema/host" );
+  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_echo_reply();
+  Init_echo_request();
+  Init_error();
+  Init_logger();
+  Init_controller();
+  Init_features_reply();
+  Init_features_request();
+  Init_set_config();
+  Init_stats_request();
+  Init_hello();
+  Init_match();
+  Init_packet_in();
+  Init_port();
+  Init_flow_removed();
+  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();
+  rb_require( "trema/exact-match" );
+}
+
+
+/*
+ * Local variables:
+ * c-basic-offset: 2
+ * indent-tabs-mode: nil
+ * End:
+ */

data/ruby/trema/tremashark.rb

@@ -0,0 +1,39 @@
+#
+# The controller class of tremashark.
+#
+# Author: Yasuhito Takamiya <yasuhito@gmail.com>
+#
+# 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/executables"
+
+
+module Trema
+  class Tremashark
+    def run
+      sh "#{ Executables.tremashark } --daemonize"
+    end
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/ruby/trema/util.rb

@@ -0,0 +1,84 @@
+#
+# Common utility functions.
+#
+# Author: Yasuhito Takamiya <yasuhito@gmail.com>
+#
+# 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/dsl"
+require "trema/executables"
+require "trema/path"
+require "trema/process"
+
+
+module Trema::Util
+  def sanity_check
+    unless Trema::Executables.compiled?
+      $stderr.puts <<-EOF
+ERROR: Trema is not compiled yet!
+
+Please try the following command:
+% ./build.rb
+EOF
+      exit false
+    end
+  end
+
+
+  def sh cmd
+    ENV[ "TREMA_HOME" ] = Trema.home
+    puts cmd if $verbose
+    unless system( cmd )
+      raise "Command '#{ cmd }' failed!"
+    end
+  end
+
+
+  def cleanup session
+    session.apps.each do | name, app |
+      app.shutdown!
+    end
+    session.switches.each do | name, switch |
+      switch.shutdown!
+    end
+    session.hosts.each do | name, host |
+      host.shutdown!
+    end
+    session.links.each do | name, link |
+      link.delete!
+    end
+
+    Dir.glob( File.join Trema.pid_directory, "*.pid" ).each do | each |
+      Trema::Process.read( each ).kill!
+    end
+
+    FileUtils.rm_f Trema::DSL::Context::PATH
+  end
+
+
+  def cleanup_current_session
+    cleanup Trema::DSL::Context.load_current
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8
+### indent-tabs-mode: nil
+### End:

data/ruby/trema/vendor-request.c

@@ -0,0 +1,193 @@
+/*
+ * Author: Nick Karanatsios <nickkaranatsios@gmail.com>
+ *
+ * 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 "trema.h"
+#include "ruby.h"
+
+
+#define VENDOR_ID 0xccddeeff
+
+
+extern VALUE mTrema;
+VALUE cVendorRequest;
+
+
+static VALUE
+vendor_request_alloc( VALUE klass ) {
+  buffer *data = alloc_buffer_with_length( 16 );
+  append_back_buffer( data, 16 );
+  memset( data->data, 'a', 16 );
+  buffer *vendor_request = create_vendor( get_transaction_id(), VENDOR_ID, data );
+  free_buffer( data );
+
+  return Data_Wrap_Struct( klass, NULL, free_buffer, vendor_request );
+}
+
+
+/*
+ * Creates a {VendorRequest} instance to facilitate sending of vendor 
+ * experimental messages.
+ *
+ * @overload initialize(options={})
+ *
+ *   @example
+ *     vendor_data = "test".unpack( "C*" ) => [ 116, 101, 115, 116 ]
+ *     VendorRequest.new
+ *     VendorRequest.new( :vendor_id => 0x3000 )
+ *     VendorRequest.new( :vendor_id => 0x3000, :vendor_data => vendor_data )
+ *     VendorRequest.new( :vendor_id => 0x3000, :vendor_data => vendor_data, :transaction_id => 123 )
+ *
+ *   @param [Hash] options
+ *     the options to create a message with.
+ *
+ *   @option options [Number] :transaction_id
+ *     Auto-generated transaction_id if not specified.
+ *
+ *   @option options [Number] :vendor_id
+ *     The assigned vendor id defaults to 0xccddeeff if not specified.
+ *
+ *   @option options [Array] :vendor_data
+ *     Fixed 16 bytes of data if not specified. User can set upto 16 bytes of any
+ *     vendor specific data.
+ *
+ *   @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 [VendorRequest]
+ *     an object that encapsulates the +OFPT_VENDOR+ OpenFlow message.
+ */
+static VALUE
+vendor_request_init( int argc, VALUE *argv, VALUE self ) {
+  buffer *vendor_request;
+  uint32_t xid = get_transaction_id();
+  uint32_t vendor = VENDOR_ID;
+  VALUE options;
+
+  Data_Get_Struct( self, buffer, vendor_request );
+  if ( rb_scan_args( argc, argv, "01", &options ) == 1 ) {
+    Check_Type( options, T_HASH );
+    VALUE xid_r;
+    if ( ( xid_r = rb_hash_aref( options, ID2SYM( rb_intern( "transaction_id" ) ) ) ) != Qnil ) {
+      if ( rb_funcall( xid_r, rb_intern( "unsigned_32bit?" ), 0 ) == Qfalse ) {
+        rb_raise( rb_eArgError, "Transaction ID must be an unsigned 32-bit integer" );
+      }
+      xid = ( uint32_t ) NUM2UINT( xid_r );
+    }
+    VALUE vendor_r;
+    if ( ( vendor_r = rb_hash_aref( options, ID2SYM( rb_intern( "vendor_id" ) ) ) ) != Qnil ) {
+      vendor = ( uint32_t ) NUM2UINT( vendor_r );
+    } 
+    VALUE data_r;
+    if ( ( data_r = rb_hash_aref( options, ID2SYM( rb_intern( "vendor_data" ) ) ) ) != Qnil ) {
+      if ( TYPE( data_r ) == T_ARRAY ) {
+        uint8_t *buf;
+        uint16_t data_length = ( uint16_t ) ( vendor_request->length - sizeof( struct ofp_vendor_header ) );
+        int32_t i;
+        buf = ( uint8_t * ) ( ( char * ) vendor_request->data + sizeof( struct ofp_vendor_header ) );
+        memset( buf, 0, data_length );
+        for ( i = 0; i < data_length && i < RARRAY( data_r )->len; i++ ) {
+          buf[ i ] = ( uint8_t ) FIX2INT( RARRAY_PTR( data_r )[ i ] );
+        }
+      }
+      else {
+        rb_raise( rb_eTypeError, "Vendor data must be specified as an array of bytes" );
+      }
+    }
+  }
+  ( ( struct ofp_header * ) ( vendor_request->data ) )->xid = htonl( xid );
+  ( ( struct ofp_vendor_header * ) ( vendor_request->data ) )->vendor = htonl( vendor );
+  return self;
+}
+
+
+/*
+ * Transaction ids, message sequence numbers matching requests to replies.
+ *
+ * @return [Number] the value of transaction id.
+ */
+static VALUE
+vendor_request_transaction_id( VALUE self ) {
+  buffer *vendor_request;
+  Data_Get_Struct( self, buffer, vendor_request );
+  uint32_t xid = ntohl( ( ( struct ofp_header * ) ( vendor_request->data ) )->xid );
+  return UINT2NUM( xid );
+}
+
+
+/*
+ * A 32-bit value that uniquely identifies the vendor.
+ *
+ * @return [Number] the value of vendor id.
+ */
+static VALUE
+vendor_request_vendor( VALUE self ) {
+  buffer *vendor_request;
+  Data_Get_Struct( self, buffer, vendor_request );
+  uint32_t vendor = ntohl( ( ( struct ofp_vendor_header * ) ( vendor_request->data ) )->vendor );
+  return UINT2NUM( vendor );
+}
+
+
+/*
+ * Vendor specific data payload.
+ *
+ * @return [Array] an array of data payload bytes.
+ * @return [nil] vendor specific data not found.
+ */
+static VALUE
+vendor_request_data( VALUE self ) {
+  VALUE data_arr;
+  buffer *vendor_request;
+  uint8_t *buf;
+  uint32_t i;
+
+  Data_Get_Struct( self, buffer, vendor_request );
+  uint16_t data_length = ( uint16_t ) ( vendor_request->length - sizeof ( struct ofp_vendor_header ) );
+
+  if ( data_length > 0 ) {
+    data_arr = rb_ary_new2( data_length );
+    buf = ( uint8_t * ) ( ( char * ) vendor_request->data + sizeof ( struct ofp_vendor_header ) );
+    for ( i = 0; i < data_length; i++ ) {
+      rb_ary_push( data_arr, INT2FIX( buf[i] ) );
+    }
+    return data_arr;
+  }
+  return Qnil;
+}
+
+
+void
+Init_vendor_request() {
+  cVendorRequest = rb_define_class_under( mTrema, "VendorRequest", rb_cObject );
+  rb_define_alloc_func( cVendorRequest, vendor_request_alloc );
+  rb_define_method( cVendorRequest, "initialize", vendor_request_init, -1 );
+  rb_define_method( cVendorRequest, "transaction_id", vendor_request_transaction_id, 0 );
+  rb_define_method( cVendorRequest, "vendor", vendor_request_vendor, 0 );
+  rb_define_method( cVendorRequest, "data", vendor_request_data, 0 );
+}
+
+
+/*
+ * Local variables:
+ * c-basic-offset: 2
+ * indent-tabs-mode: nil
+ * End:
+ */

data/ruby/trema/vendor-request.h

@@ -0,0 +1,44 @@
+/*
+ * Ruby wrapper class for OFPT_VENDOR 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
+ * 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.
+ */
+
+
+#ifndef VENDOR_REQUEST_H
+#define VENDOR_REQUEST_H
+
+
+#include "ruby.h"
+
+
+extern VALUE cVendorRequest;
+
+
+void Init_vendor_request( void );
+
+
+#endif // VENDOR_REQUEST_H
+
+
+/*
+ * Local variables:
+ * c-basic-offset: 2
+ * indent-tabs-mode: nil
+ * End:
+ */