trema 0.1.3

data/ruby/trema/ofctl.rb

@@ -0,0 +1,62 @@
+#
+# The controller class of ovs-ofctl.
+#
+# 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"
+require "trema/flow"
+
+
+module Trema
+  class Ofctl
+    def add_flow switch, options
+      actions = options[ :actions ]
+      options.delete :actions
+      option_string = options.collect do | k, v |
+        "#{ k }=#{ v }"
+      end.join( "," )
+      sh "sudo #{ Executables.ovs_ofctl } add-flow #{ switch.network_device } #{ option_string },actions=#{ actions } 2>/dev/null"
+    end
+
+
+    def flows switch
+      dump_flows( switch ).split( "\n" )[ 1..-1 ].collect do | each |
+        Trema::Flow.parse( each )
+      end.compact
+    end
+
+
+    def users_flows switch
+      flows( switch ).select( &:users_flow? )
+    end
+
+
+    def dump_flows switch
+      `sudo #{ Executables.ovs_ofctl } dump-flows #{ switch.network_device } 2>&1`
+    end
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/ruby/trema/open-vswitch.rb

@@ -0,0 +1,154 @@
+#
+# 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/daemon"
+require "trema/executables"
+require "trema/ofctl"
+require "trema/openflow-switch"
+require "trema/path"
+
+
+module Trema
+  #
+  # Open vSwitch support (http://openvswitch.org)
+  #
+  class OpenVswitch < OpenflowSwitch
+    include Trema::Daemon
+
+
+    DEFAULT_PORT = 6633
+
+
+    log_file { | vswitch | "openflowd.#{ vswitch.name }.log" }
+    command { | vswitch | vswitch.__send__ :command }
+
+
+    #
+    # Creates a new Open vSwitch from {DSL::Vswitch}
+    #
+    # @example
+    #   vswitch = Trema::OpenVswitch.new( stanza )
+    #
+    # @return [OpenVswitch]
+    #
+    def initialize stanza, port = DEFAULT_PORT
+      super stanza
+      @port = port
+      @interfaces = []
+    end
+
+
+    #
+    # Add a network interface used for a virtual port
+    #
+    # @example
+    #   vswitch << "trema3-0"
+    #
+    # @return [Array]
+    #
+    def << interface
+      @interfaces << interface
+      restart!
+      @interfaces
+    end
+
+
+    #
+    # Returns the network device name associated with the datapath's
+    # local port
+    #
+    # @example
+    #   vswitch.network_device  #=> "vsw_0xabc"
+    #
+    # @return [String]
+    #
+    def network_device
+      "vsw_#{ @stanza.fetch :dpid_short }"
+    end
+
+
+    #
+    # Returns flow entries
+    #
+    # @example
+    #   vswitch.flows  #=> [ flow0, flow1, ... ]
+    #
+    # @return [Array]
+    #
+    def flows
+      Ofctl.new.users_flows( self )
+    end
+
+
+    ############################################################################
+    private
+    ############################################################################
+
+
+    def command
+      "sudo #{ Executables.ovs_openflowd } #{ options }"
+    end
+
+
+    def options
+      default_options.join( " " ) + " netdev@#{ network_device } tcp:#{ ip }:#{ @port }"
+    end
+
+
+    def default_options
+      [
+       "--detach",
+       "--out-of-band",
+       "--fail=closed",
+       "--inactivity-probe=180",
+       "--rate-limit=40000",
+       "--burst-limit=20000",
+       "--pidfile=#{ pid_file }",
+       "--verbose=ANY:file:dbg",
+       "--verbose=ANY:console:err",
+       "--log-file=#{ log_file }",
+       "--datapath-id=#{ dpid_long }",
+       "--unixctl=#{ unixctl }",
+      ] + ports_option
+    end
+
+
+    def ip
+      @stanza.fetch :ip
+    end
+
+
+    def ports_option
+      @interfaces.empty? ? [] : [ "--ports=#{ @interfaces.join( "," ) }" ]
+    end
+
+
+    def unixctl
+      File.join Trema.sock_directory, "ovs-openflowd.#{ name }.ctl"
+    end
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/ruby/trema/openflow-error.c

@@ -0,0 +1,191 @@
+/*
+ * 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 cOpenflowError;
+
+
+/*
+ * The occurence of reported errors/exceptions manifested as an instance - a
+ * {OpenflowError} object. The user would not explicitly instantiate 
+ * a {OpenflowError} but would be created while parsing the +OFPT_ERROR+ message.
+ *
+ * @overload initialize(options={})
+ *
+ *   @example
+ *     OpenflowError.new(
+ *       :datapath_id => 0xabc,
+ *       :transaction_id => 123,
+ *       :type => OFPET_BAD_REQUEST,
+ *       :code => OFPBRC_BAD_SUBTYPE,
+ *       :data => data
+ *     )
+ *
+ *   @param [Hash] options
+ *     the options to create a message with.
+ *
+ *   @option options [Number] :datapath_id
+ *     message originator identifier. This idenfier is typed as a 64-bit number
+ *     and must be unique in a given domain of application deployment.
+ *
+ *   @option options [Number] :transaction_id
+ *     the transaction_id of the offended message.
+ *
+ *   @option options [Number] :type
+ *     the command or action that failed signifies the kind of error.
+ *
+ *   @option options [Number] :code
+ *     the reason of the failed type error.
+ *
+ *   @option options [String] :data
+ *     variable length data interpreted based on type and code.
+ *
+ *   @return [OpenflowError]
+ *     an object that encapsulates the +OFPT_ERROR+ OpenFlow message.
+ */
+static VALUE
+openflow_error_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
+openflow_error_datapath_id( VALUE self ) {
+  return rb_hash_aref( rb_iv_get( self, "@attribute" ), ID2SYM( rb_intern( "datapath_id" ) ) );
+}
+
+
+/*
+ * The transaction_id of the offended message.
+ *
+ * @return [Number] the value of transaction_id.
+ */
+static VALUE
+openflow_error_transaction_id( VALUE self ) {
+  return rb_hash_aref( rb_iv_get( self, "@attribute" ), ID2SYM( rb_intern( "transaction_id" ) ) );
+}
+
+
+/*
+ * The command or action that failed.
+ *
+ * @return [Number] the value of type.
+ */
+static VALUE
+openflow_error_type( VALUE self ) {
+  return rb_hash_aref( rb_iv_get( self, "@attribute" ), ID2SYM( rb_intern( "type" ) ) );
+}
+
+
+/*
+ * The reason of the failed type error.
+ *
+ * @return [Number] the value of code.
+ */
+static VALUE
+openflow_error_code( VALUE self ) {
+  return rb_hash_aref( rb_iv_get( self, "@attribute" ), ID2SYM( rb_intern( "code" ) ) );
+}
+
+
+/*
+ * Variable length data interpreted based on type and code.
+ *
+ * @return [String] if error type is +OFPET_HELLO_FAILED+.
+ * @return [Array] an array of bytes of the offending message for any other error type.
+ */
+static VALUE
+openflow_error_data( VALUE self ) {
+  return rb_hash_aref( rb_iv_get( self, "@attribute" ), ID2SYM( rb_intern( "data" ) ) );
+}
+
+
+void
+Init_openflow_error() {
+  cOpenflowError = rb_define_class_under( mTrema, "OpenflowError", rb_cObject );
+  rb_define_method( cOpenflowError, "initialize", openflow_error_init, 1 );
+  rb_define_method( cOpenflowError, "datapath_id", openflow_error_datapath_id, 0 );
+  rb_define_method( cOpenflowError, "transaction_id", openflow_error_transaction_id, 0 );
+  rb_define_method( cOpenflowError, "type", openflow_error_type, 0 );
+  rb_define_method( cOpenflowError, "code", openflow_error_code, 0 );
+  rb_define_method( cOpenflowError, "data", openflow_error_data, 0 );
+}
+
+
+void
+handle_openflow_error(
+  uint64_t datapath_id,
+  uint32_t transaction_id,
+  uint16_t type,
+  uint16_t code,
+  buffer *body,
+  void *user_data
+) {
+  VALUE controller = ( VALUE ) user_data;
+  if ( rb_respond_to( controller, rb_intern( "openflow_error" ) ) == 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( "type" ) ), UINT2NUM( type ) );
+  rb_hash_aset( attributes, ID2SYM( rb_intern( "code" ) ), UINT2NUM( code ) );
+
+  switch ( type ) {
+    case OFPET_HELLO_FAILED:
+    case OFPET_BAD_REQUEST:
+    case OFPET_BAD_ACTION:
+    case OFPET_FLOW_MOD_FAILED:
+    case OFPET_PORT_MOD_FAILED:
+    case OFPET_QUEUE_OP_FAILED:
+    {
+      if ( body != NULL ) {
+        if ( body->length ) {
+          rb_hash_aset( attributes, ID2SYM( rb_intern( "data" ) ), rb_str_new( body->data, ( long ) body->length ) );
+        }
+      }
+    }
+      break;
+    default:
+      critical( "Un-handled error type ( type = %u ),", type );
+      break;
+  }
+  VALUE openflow_error = rb_funcall( cOpenflowError, rb_intern( "new" ), 1, attributes );
+  rb_funcall( controller, rb_intern( "openflow_error" ), 1, openflow_error );
+}
+
+
+/*
+ * Local variables:
+ * c-basic-offset: 2
+ * indent-tabs-mode: nil
+ * End:
+ */

data/ruby/trema/openflow-error.h

@@ -0,0 +1,53 @@
+/*
+ * 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 OPENFLOW_ERROR_H
+#define OPENFLOW_ERROR_H
+
+
+#include "ruby.h"
+#include "trema.h"
+
+
+extern VALUE cOpenflowError;
+
+
+void Init_openflow_error( void );
+
+
+void handle_openflow_error(
+        uint64_t datapath_id,
+        uint32_t transaction_id,
+        uint16_t type,
+        uint16_t code,
+        const buffer *body,
+        void *user_data
+        );
+
+
+#endif // OPENFLOW_ERROR_H
+
+
+/*
+ * Local variables:
+ * c-basic-offset: 2
+ * indent-tabs-mode: nil
+ * End:
+ */