trema 0.1.3

data/ruby/trema/action-vendor.h

@@ -0,0 +1,42 @@
+/*
+ * 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 ACTION_VENDOR_H
+#define ACTION_VENDOR_H
+
+
+#include "ruby.h"
+
+
+extern VALUE cActionVendor;
+
+
+void Init_action_vendor( void );
+
+
+#endif // ACTION_VENDOR_H
+
+
+/*
+ * Local variables:
+ * c-basic-offset: 2
+ * indent-tabs-mode: nil
+ * End:
+ */

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

@@ -0,0 +1,70 @@
+#
+# 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 AggregateStatsReply < StatsHelper
+    FIELDS = %w(packet_count byte_count flow_count)
+    FIELDS.each { |field| attr_reader field.intern }
+
+
+    # Aggregate counters for flows.
+    # A user would not explicitly instantiate a {AggregateStatsReply} object but
+    # would be created as a result of parsing the +OFPT_STATS_REPLY(OFPST_AGGREGATE)
+    # message.
+    #
+    # @overload initialize(options={})
+    #
+    #   @example 
+    #     AggregateStatsReply.new(
+    #       :packet_count => 10,
+    #       :byte_count => 640,
+    #       :flow_count => 2
+    #     )
+    #
+    #   @param [Hash] options 
+    #     the options to create this instance with.
+    #
+    #   @option options [Number] :packet_count
+    #     the total number of packets that matched.
+    #
+    #   @option options [Number] :byte_count
+    #     the total number of bytes from packets that matched.
+    #
+    #   @option options [Number] :flow_count
+    #     the total number of flows that matched.
+    #
+    #   @return [AggregateStatsReply]
+    #     an object that encapsulates the OFPST_STATS_REPLY(OFPST_AGGREGATE) 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/app.rb

@@ -0,0 +1,112 @@
+#
+# 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/network-component"
+
+
+module Trema
+  #
+  # Trema applications
+  #
+  class App < NetworkComponent
+    include Trema::Daemon
+
+
+    attr_reader :stanza
+
+
+    command { | app | [ app.command, app.stanza[ :options ] ].compact.join " " }
+
+
+    #
+    # Creates a new Trema application from {DSL::App}
+    #
+    # @example
+    #   app = Trema::App.new( stanza )
+    #
+    # @return [App]
+    #
+    # @api public
+    #
+    def initialize stanza
+      @stanza = stanza
+      if /\.rb\Z/=~ @stanza.fetch( :name )  # ruby?
+        require "trema"
+        path = @stanza.fetch( :path )
+        ARGV.replace [ path ]
+        $LOAD_PATH << File.dirname( path )
+        Trema.module_eval IO.read( path )
+      else
+        App.add self
+      end
+    end
+
+
+    #
+    # Returns the name of application
+    #
+    # @example
+    #   app.name #=> "Trema Tetris"
+    #
+    # @return [String]
+    #
+    # @api public
+    #
+    def name
+      @stanza[ :name ]
+    end
+
+
+    #
+    # Runs as a daemon
+    #
+    # @example
+    #   app.daemonize! #=> self
+    #
+    # @return [App]
+    #
+    # @api public
+    #
+    def daemonize!
+      sh [ command, "-d", @stanza[ :options ] ].compact.join( " " )
+      self
+    end
+
+
+    #
+    # Returns application's command to execute
+    #
+    # @return [String]
+    #
+    # @api private
+    #
+    def command
+      "#{ @stanza[ :path ] } --name #{ name }"
+    end
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/ruby/trema/barrier-reply.c

@@ -0,0 +1,99 @@
+/*
+ * 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 cBarrierReply;
+
+
+/*
+ * A new instance of {BarrierReply} constructed when +OFPT_BARRIER_REPLY+
+ * message received.
+ *
+ * @overload initialize(datapath_id, transaction_id)
+ *
+ * @param [Number] datapath_id
+ *   a unique name that identifies an OpenVSwitch, the message originator.
+ *
+ * @param [Number] transaction_id
+ *   value copied from the +OFPT_BARRIER_REQUEST+ message.
+ *
+ * @return [BarrierReply] self an object that encapsulates the +OFPT_BARRIER_REPLY+ message.
+ */
+static VALUE
+barrier_reply_init( VALUE self, VALUE datapath_id, VALUE transaction_id ) {
+  rb_iv_set( self, "@datapath_id", datapath_id );
+  rb_iv_set( self, "@transaction_id", transaction_id );
+  return self;
+}
+
+
+/*
+ * Message originator identifier.
+ *
+ * @return [Number] the value of datapath_id.
+ */
+static VALUE
+barrier_reply_datapath_id( VALUE self ) {
+  return rb_iv_get( self, "@datapath_id" );
+}
+
+
+/*
+ * Transaction ids, message sequence numbers matching requests to replies.
+ *
+ * @return [Number] the value of transaction ID.
+ */
+static VALUE
+barrier_reply_transaction_id( VALUE self ) {
+  return rb_iv_get( self, "@transaction_id" );
+}
+
+
+void
+Init_barrier_reply() {
+  cBarrierReply = rb_define_class_under( mTrema, "BarrierReply", rb_cObject );
+  rb_define_method( cBarrierReply, "initialize", barrier_reply_init, 2 );
+  rb_define_method( cBarrierReply, "datapath_id", barrier_reply_datapath_id, 0 );
+  rb_define_method( cBarrierReply, "transaction_id", barrier_reply_transaction_id, 0 );
+}
+
+
+void
+handle_barrier_reply( uint64_t datapath_id, uint32_t transaction_id, void *user_data ) {
+  VALUE controller = ( VALUE ) user_data;
+  if ( rb_respond_to( controller, rb_intern( "barrier_reply" ) ) == Qfalse ) {
+    return;
+  }
+
+  VALUE barrier_reply = rb_funcall( cBarrierReply, rb_intern( "new" ), 2, ULL2NUM( datapath_id ), UINT2NUM( transaction_id ) );
+  rb_funcall( controller, rb_intern( "barrier_reply" ), 1, barrier_reply );
+}
+
+
+/*
+ * Local variables:
+ * c-basic-offset: 2
+ * indent-tabs-mode: nil
+ * End:
+ */

data/ruby/trema/barrier-reply.h

@@ -0,0 +1,46 @@
+/*
+ * 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 BARRIER_REPLY_H
+#define BARRIER_REPLY_H
+
+
+#include "ruby.h"
+#include "trema.h"
+
+
+extern VALUE cBarrierReply;
+
+
+void Init_barrier_reply( void );
+
+
+void handle_barrier_reply( uint64_t datapath_id, uint32_t transaction_id, void *user_data );
+
+
+#endif // BARRIER_REPLY_H
+
+
+/*
+ * Local variables:
+ * c-basic-offset: 2
+ * indent-tabs-mode: nil
+ * End:
+ */

data/ruby/trema/barrier-request.c

@@ -0,0 +1,108 @@
+/*
+ * 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 cBarrierRequest;
+
+
+static VALUE
+barrier_request_alloc( VALUE klass ) {
+  buffer *barrier_request = create_barrier_request( get_transaction_id() );
+  return Data_Wrap_Struct( klass, NULL, free_buffer, barrier_request );
+}
+
+
+/*
+ * A barrier request message could be sent to ensure that an operation
+ * completed successfully signaled with the reception of a barrier reply message.
+ *
+ * @overload initialize(options={})
+ *   @example 
+ *     BarrierRequest.new
+ *     BarrierRequest.new( :transaction_id => 123 )
+ *
+ *   @param [Hash] options
+ *     the options to create a message with.
+ *
+ *   @option options [Number] :transaction_id
+ *     an unsigned 32-bit 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 [BarrierRequest]
+ *     an object that encapsulates the +OPFT_BARRIER_REQUEST+ OpenFlow message.
+ */
+static VALUE
+barrier_request_init( int argc, VALUE *argv, VALUE self ) {
+  buffer *barrier_request;
+  Data_Get_Struct( self, buffer, barrier_request );
+  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 * ) ( barrier_request->data ) )->xid = htonl( xid );
+  return self;
+}
+
+
+/*
+ * Transaction ids, message sequence numbers matching requests to replies.
+ *
+ * @return [Number] the value of transaction id.
+ */
+static VALUE
+barrier_request_transaction_id( VALUE self ) {
+  buffer *barrier_request;
+  Data_Get_Struct( self, buffer, barrier_request );
+  uint32_t xid = ntohl( ( ( struct ofp_header * ) ( barrier_request->data ) )->xid );
+  return UINT2NUM( xid );
+}
+
+
+void
+Init_barrier_request() {
+  cBarrierRequest = rb_define_class_under( mTrema, "BarrierRequest", rb_cObject );
+  rb_define_alloc_func( cBarrierRequest, barrier_request_alloc );
+  rb_define_method( cBarrierRequest, "initialize", barrier_request_init, -1 );
+  rb_define_method( cBarrierRequest, "transaction_id", barrier_request_transaction_id, 0 );
+}
+
+
+/*
+ * Local variables:
+ * c-basic-offset: 2
+ * indent-tabs-mode: nil
+ * End:
+ */