trema 0.1.3

data/ruby/trema/vendor-stats-reply.rb

@@ -0,0 +1,62 @@
+#
+# 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.
+#
+
+
+require "trema/stats-helper"
+
+
+module Trema
+  class VendorStatsReply < StatsHelper
+    FIELDS = %w(vendor_id)
+    FIELDS.each { |field| attr_reader field.intern }
+
+    
+    # Vendor statistics reply.
+    # A user would not explicitly instantiate a {VendorStatsReply} object but would
+    # be created as a result of parsing the +OFPT_STATS_REPLY(OFPST_VENDOR)+
+    # openflow message.
+    #
+    # @overload initialize(otions={})
+    #
+    #   @example 
+    #     VendorStatsReply.new(
+    #       :vendor_id => 123
+    #     )
+    #
+    #   @param [Hash] options
+    #     the options to create this instance with.
+    #
+    #   @option options [Number] :vendor_id
+    #     the specific vendor identifier.
+    #
+    #   @return [VendorStatsReply] 
+    #     an object that encapsulates the OFPST_STATS_REPLY(OPPST_VENDOR) OpenFlow message.
+    #
+    def initialize options
+      super FIELDS, options
+    end
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/ruby/trema/vendor.c

@@ -0,0 +1,152 @@
+/*
+ * 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"
+
+
+extern VALUE mTrema;
+VALUE cVendor;
+
+
+/*
+ * Creates a {Vendor} instance that encapsulates the handling of vendor's messages.
+ *
+ * @overload initialize(options={})
+ *
+ *   @example 
+ *     Vendor.new(
+ *       :datapath_id => 0xabc,
+ *       :transaction_id => 123,
+ *       :vendor => vendor_id,
+ *       :buffer => data
+ *     )
+ *
+ *   @param [Hash] options
+ *     the options to create a message with.
+ *
+ *   @option options [Number] :datapath_id
+ *     message originator identifier.
+ *
+ *   @option options [Number] :transaction_id
+ *     zero for unsolicited message otherwise a positive number.
+ *
+ *   @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.
+ */
+static VALUE
+vendor_init( VALUE self, VALUE options ) {
+  rb_iv_set( self, "@attribute", options );
+  return self;
+}
+
+/*
+ * 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" ) ) );
+}
+
+
+/*
+ * Zero for unsolicited message otherwise a positive number copied from request
+ * message.
+ *
+ * @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" ) ) );
+}
+
+
+/*
+ * (see VendorRequest#vendor)
+ */
+static VALUE
+vendor_vendor( VALUE self ) {
+  return rb_hash_aref( rb_iv_get( self, "@attribute" ), ID2SYM( rb_intern( "vendor" ) ) );
+}
+
+
+/*
+ * Vendor's arbitrary length data.
+ *
+ * @return [Buffer] the value of buffer.
+ */
+static VALUE
+vendor_buffer( VALUE self ) {
+  return rb_hash_aref( rb_iv_get( self, "@attribute" ), ID2SYM( rb_intern( "buffer" ) ) );
+}
+
+
+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_method( cVendor, "transaction_id", vendor_transaction_id, 0 );
+  rb_define_method( cVendor, "vendor", vendor_vendor, 0 );
+  rb_define_method( cVendor, "buffer", vendor_buffer, 0 );
+}
+
+
+void
+handle_vendor(
+  uint64_t datapath_id,
+  uint32_t transaction_id,
+  uint32_t vendor,
+  buffer *body,
+  void *user_data
+) {
+  VALUE controller = ( VALUE ) user_data;
+  if ( rb_respond_to( controller, rb_intern( "vendor" ) ) == Qfalse ) {
+    return;
+  }
+  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( "vendor" ) ), UINT2NUM( vendor ) );
+
+  if ( body->length ) {
+    rb_hash_aset( attributes, ID2SYM( rb_intern( "buffer" ) ), rb_str_new( body->data, ( long ) body->length ) );
+  }
+  VALUE vendor_r = rb_funcall( cVendor, rb_intern( "new" ), 1, attributes );
+  rb_funcall( controller, rb_intern( "vendor" ), 1, vendor_r );
+}
+
+
+/*
+ * Local variables:
+ * c-basic-offset: 2
+ * indent-tabs-mode: nil
+ * End:
+ */

data/ruby/trema/vendor.h

@@ -0,0 +1,52 @@
+/*
+ * 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_H
+#define VENDOR_H
+
+
+#include "ruby.h"
+#include "trema.h"
+
+
+extern VALUE cVendor;
+
+
+void Init_vendor( void );
+
+
+void handle_vendor(
+        uint64_t datapath_id,
+        uint32_t transaction_id,
+        uint32_t vendor,
+        const buffer *body,
+        void *user_data
+        );
+
+
+#endif // VENDOR_H
+
+
+/*
+ * Local variables:
+ * c-basic-offset: 2
+ * indent-tabs-mode: nil
+ * End:
+ */

data/ruby/trema/version.rb

@@ -0,0 +1,30 @@
+#
+# 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.
+#
+
+
+module Trema
+  VERSION = IO.read( File.join File.dirname( __FILE__ ), "..", "..", "VERSION" ).chomp.freeze
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8
+### indent-tabs-mode: nil
+### End:

data/spec/spec_helper.rb

@@ -0,0 +1,153 @@
+#
+# 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.
+#
+
+
+$LOAD_PATH << File.join( File.dirname( __FILE__ ), "..", "ruby" )
+$LOAD_PATH.unshift File.expand_path( File.join File.dirname( __FILE__ ), "..", "vendor", "ruby-ifconfig-1.2", "lib" )
+
+
+require "rubygems"
+
+require "rspec"
+require "trema"
+require "trema/dsl/configuration"
+require "trema/dsl/context"
+require "trema/ofctl"
+require "trema/shell"
+require "trema/util"
+
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir[ "#{ File.dirname( __FILE__ ) }/support/**/*.rb" ].each do | each |
+  require File.expand_path( each )
+end
+
+
+include Trema
+
+
+def controller name
+  Trema::App[ name ]
+end
+
+
+def vswitch name
+  Trema::Switch[ name ]
+end
+
+
+def vhost name
+  Trema::Host[ name ]
+end
+
+
+def send_packets source, dest, options = {}
+  Trema::Shell.send_packets source, dest, options
+end
+
+
+include Trema::Util
+
+
+class Network
+  def initialize &block
+    @context = Trema::DSL::Parser.new.eval( &block )
+  end
+
+
+  def run controller_class, &test
+    begin
+      trema_run controller_class
+      test.call
+    ensure
+      trema_kill
+    end
+  end
+
+
+  ################################################################################
+  private
+  ################################################################################
+
+
+  def trema_run controller_class
+    controller = controller_class.new
+    if not controller.is_a?( Trema::Controller )
+      raise "#{ controller_class } is not a subclass of Trema::Controller"
+    end
+    Trema::DSL::Context.new( @context ).dump
+
+    app_name = controller.name
+    rule = { :port_status => app_name, :packet_in => app_name, :state_notify => app_name }
+    sm = SwitchManager.new( rule, @context.port )
+    sm.no_flow_cleanup = true
+    sm.run!
+
+    @context.links.each do | name, each |
+      each.add!
+    end
+    @context.hosts.each do | name, each |
+      each.run!
+    end
+    @context.switches.each do | name, each |
+      each.run!
+      drop_packets_from_unknown_hosts each
+    end
+    @context.links.each do | name, each |
+      each.up!
+    end
+    @context.hosts.each do | name, each |
+      each.add_arp_entry @context.hosts.values - [ each ]
+    end
+
+    @th_controller = Thread.start do
+      controller.run!
+    end
+    sleep 2  # FIXME: wait until controller.up?
+  end
+
+
+  def trema_kill
+    cleanup_current_session
+    @th_controller.join if @th_controller
+    sleep 2  # FIXME: wait until switch_manager.down?
+  end
+
+
+  def drop_packets_from_unknown_hosts switch
+    ofctl = Trema::Ofctl.new
+    ofctl.add_flow switch, :priority => 0, :actions => "drop"
+    @context.hosts.each do | name, each |
+      ofctl.add_flow switch, :dl_type => "0x0800", :nw_src => each.ip, :priority => 1, :actions => "controller"
+    end
+  end
+end
+
+
+def network &block
+  Network.new &block
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End: