trema 0.1.3

data/ruby/trema/get-config-request.h

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

data/ruby/trema/hello.c

@@ -0,0 +1,110 @@
+/*
+ * 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 "trema.h"
+#include "ruby.h"
+
+
+extern VALUE mTrema;
+VALUE cHello;
+
+
+static VALUE
+hello_alloc( VALUE klass ) {
+  buffer *hello = create_hello( 0 );
+  return Data_Wrap_Struct( klass, NULL, free_buffer, hello );
+}
+
+
+/*
+ * Creates a Hello OpenFlow message.
+ *
+ * @overload initialize(options={})
+ *
+ *   @example
+ *     Hello.new
+ *     Hello.new( :transaction_id => 123 )
+ *
+ *   @param [Hash] options
+ *     the options to create a message with.
+ *
+ *   @option options [Number] :transaction_id
+ *     An unsigned 32bit integer number associated with this message.
+ *     If not specified, an auto-generated value is set.
+ *
+ *   @raise [ArgumentError] if transaction ID is not an unsigned 32-bit integer.
+ *   @raise [TypeError] if options is not a Hash.
+ *
+ *   @return [Hello]
+ *     an object that encapsulates the +OPFT_HELLO+ OpenFlow message.
+ */
+static VALUE
+hello_init( int argc, VALUE *argv, VALUE self ) {
+  buffer *hello;
+  Data_Get_Struct( self, buffer, hello );
+  uint32_t xid = get_transaction_id();
+  VALUE options;
+
+  if ( rb_scan_args( argc, argv, "01", &options ) == 1 ) {
+    Check_Type( options, T_HASH );
+    VALUE xid_ruby;
+    if ( ( xid_ruby = rb_hash_aref( options, ID2SYM( rb_intern( "transaction_id" ) ) ) ) != Qnil ) {
+      if ( rb_funcall( xid_ruby, rb_intern( "unsigned_32bit?" ), 0 ) == Qfalse ) {
+        rb_raise( rb_eArgError, "Transaction ID must be an unsigned 32-bit integer" );
+      }
+      xid = ( uint32_t ) NUM2UINT( xid_ruby );
+    }
+  }
+  ( ( struct ofp_header * ) ( hello->data ) )->xid = htonl( xid );
+  return self;
+}
+
+
+/*
+ * An unsigned 32bit integer number associated with this
+ * message. Replies use the same id as was in the request to
+ * facilitate pairing.
+ *
+ * @return [Number] the value of transaction ID.
+ */
+static VALUE
+hello_transaction_id( VALUE self ) {
+  buffer *hello;
+  Data_Get_Struct( self, buffer, hello );
+  uint32_t xid = ntohl( ( ( struct ofp_header * ) ( hello->data ) )->xid );
+  return UINT2NUM( xid );
+}
+
+
+void
+Init_hello() {
+  cHello = rb_define_class_under( mTrema, "Hello", rb_cObject );
+  rb_define_alloc_func( cHello, hello_alloc );
+  rb_define_method( cHello, "initialize", hello_init, -1 );
+  rb_define_method( cHello, "transaction_id", hello_transaction_id, 0 );
+}
+
+
+/*
+ * Local variables:
+ * c-basic-offset: 2
+ * indent-tabs-mode: nil
+ * End:
+ */

data/ruby/trema/hello.h

@@ -0,0 +1,44 @@
+/*
+ * Ruby wrapper class of OpenFlow hello message.
+ *
+ * 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.
+ */
+
+
+#ifndef HELLO_H
+#define HELLO_H
+
+
+#include "ruby.h"
+
+
+extern VALUE cHello;
+
+
+void Init_hello( void );
+
+
+#endif // HELLO_H
+
+
+/*
+ * Local variables:
+ * c-basic-offset: 2
+ * indent-tabs-mode: nil
+ * End:
+ */

data/ruby/trema/host.rb

@@ -0,0 +1,257 @@
+#
+# 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/cli"
+require "trema/phost"
+require "trema/network-component"
+
+
+module Trema
+  #
+  # The controller class of host
+  #
+  class Host < NetworkComponent
+    #
+    # Set a network interface
+    #
+    # @example
+    #   host.interface #=> "trema0-1"
+    #
+    # @return [String]
+    #
+    # @api public
+    #
+    attr_accessor :interface
+
+
+    #
+    # Creates a new Trema host from {DSL::Vhost}
+    #
+    # @example
+    #   host = Trema::Host.new( stanza )
+    #
+    # @return [Host]
+    #
+    # @api public
+    #
+    def initialize stanza
+      @stanza = stanza
+      @phost = Phost.new( self )
+      @cli = Cli.new( self )
+      @index = Host.instances.size
+      Host.add self
+    end
+
+
+    #
+    # Define host attribute accessors
+    #
+    # @example
+    #   host.name  # delegated to @stanza[ :name ]
+    #
+    # @return an attribute value
+    #
+    # @api public
+    #
+    def method_missing message, *args
+      @stanza.__send__ :[], message
+    end
+
+
+    #
+    # Returns IP address
+    #
+    # @example
+    #   host.ip #=> "192.168.0.1"
+    #
+    # @return [String]
+    #
+    # @api public
+    #
+    def ip
+      stanza_ip = @stanza[ :ip ]
+      if stanza_ip.nil?
+        # FIXME: Find unused addresses
+        "192.168.0.#{ @index + 1 }"
+      else
+        stanza_ip
+      end
+    end
+
+
+    #
+    # Returns MAC address
+    #
+    # @example
+    #   host.mac #=> "00:00:00:00:00:01"
+    #
+    # @return [String]
+    #
+    # @api public
+    #
+    def mac
+      stanza_mac = @stanza[ :mac ]
+      if stanza_mac.nil?
+        "00:00:00:00:00:#{ format "%02x", @index + 1 }"
+      else
+        stanza_mac
+      end
+    end
+
+
+    #
+    # Returns netmask
+    #
+    # @example
+    #   host.netmask #=> "255.255.0.0"
+    #
+    # @return [String]
+    #
+    # @api public
+    #
+    def netmask
+      stanza_netmask = @stanza[ :netmask ]
+      if stanza_netmask.nil?
+        "255.255.255.255"
+      else
+        stanza_netmask
+      end
+    end
+
+
+    #
+    # Runs a host process
+    #
+    # @example
+    #   host.run! => self
+    #
+    # @return [Host]
+    #
+    # @api public
+    #
+    def run!
+      @phost.run!
+      @cli.set_ip_and_mac_address
+      @cli.enable_promisc if @stanza[ :promisc ]
+      self
+    end
+
+
+    #
+    # Kills running host
+    #
+    # @example
+    #   host.shutdown!
+    #
+    # @return [undefined]
+    #
+    # @api public
+    #
+    def shutdown!
+      @phost.shutdown!
+    end
+
+
+    #
+    # Add arp entries of <code>hosts</code>
+    #
+    # @example
+    #   host.add_arp_entry [ host1, host2, host3 ]
+    #
+    # @return [undefined]
+    #
+    # @api public
+    #
+    def add_arp_entry hosts
+      hosts.each do | each |
+        @cli.add_arp_entry each
+      end
+    end
+
+
+    #
+    # Send packets to <code>dest</code>
+    #
+    # @example
+    #   host.send_packet host1, :pps => 100
+    #
+    # @return [undefined]
+    #
+    # @api public
+    #
+    def send_packet dest, options = {}
+      dest_host = if dest.is_a?( String )
+                    vhost( dest )
+                  else
+                    dest
+                  end
+      @cli.send_packets dest_host, options
+    end
+
+
+    def stats type
+      case type
+      when :tx
+        @cli.tx_stats
+      when :rx
+        @cli.rx_stats
+      else
+        raise
+      end
+    end
+
+
+    #
+    # Returns tx stats
+    #
+    # @example
+    #   host.tx_stats
+    #
+    # @return [Stat]
+    #
+    # @api public
+    #
+    def tx_stats
+      @cli.tx_stats
+    end
+
+
+    #
+    # Returns rx stats
+    #
+    # @example
+    #   host.rx_stats
+    #
+    # @return [Stat]
+    #
+    # @api public
+    #
+    def rx_stats
+      @cli.rx_stats
+    end
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End: