trema 0.1.3

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

@@ -0,0 +1,109 @@
+#
+# 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 FlowStatsReply < StatsHelper
+    FIELDS = %w(length table_id match duration_sec duration_nsec) +
+      %w(priority idle_timeout hard_timeout cookie packet_count byte_count actions)
+    FIELDS.each { |field| attr_reader field.intern }
+
+    
+    # Flow counters for one or more matched flows.
+    # A user would not explicitly instantiate a {FlowStatsReply} object but
+    # would be created as a result of parsing the +OFPT_STATS_REPLY(OFPST_FLOW)+
+    # message.
+    #
+    # @overload initialize(options={})
+    #
+    #   @example 
+    #     FlowStatsReply.new(
+    #       :length => 96,
+    #       :table_id => 0, 
+    #       :match => Match.new
+    #       :duration_sec => 10,
+    #       :duration_nsec => 106000000,
+    #       :priority => 0,
+    #       :idle_timeout => 0,
+    #       :hard_timeout => 0,
+    #       :cookie => 0xabcd,
+    #       :packet_count => 1,
+    #       :byte_count => 1,
+    #       :actions => [ ActionOutput.new ]
+    #     )
+    #
+    #   @param [Hash] options
+    #     the options to create this instance with.
+    #
+    #   @option options [Number] :length
+    #     the length of this packet.
+    #
+    #   @option options [Number] :table_id
+    #     set to zero.
+    #
+    #   @option options [Match] :match
+    #     Match object describing flow fields.
+    #
+    #   @option options [Number] :duration_sec
+    #     the time in seconds the flow been active.
+    #
+    #   @option options [Number] :duration_nsec
+    #     the time in nanosecs the flow been active.
+    #
+    #   @option options [Number] :priority
+    #     the priority of the flow.
+    #
+    #   @option options [Number] :idle_timeout
+    #     an inactivity time in seconds before the flow is deleted. Zero means
+    #     no deletion.
+    #
+    #   @option options [Number] :hard_timeout
+    #     a fixed time interval before the flow is deleted. Zero means no 
+    #     deletion.
+    #
+    #   @option options [Number] :cookie
+    #     an opaque identifier used as a unique key to match flow entries.
+    #
+    #   @option options [Number] :packet_count
+    #     count of the number of packets matched the flow.
+    #
+    #   @option options [Number] :byte_count
+    #     count of the number of bytes matched the flow.
+    #
+    #   @option options [Array] :actions
+    #     an array of action objects for the flow.
+    #
+    #   @return [FlowStatsReply]
+    #     an object that encapsulates the OFPST_STATS_REPLY(OPPST_FLOW) 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/flow.rb

@@ -0,0 +1,56 @@
+#
+# 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
+  class Flow
+    attr_reader :dl_type
+
+
+    def self.parse line
+      flow = self.new
+      # to simplify parsing
+      line.sub!(/actions=.*,.*$/) { | match | match.gsub(/,/,'/') }
+      line.strip.split( /[,\s]\s*/ ).each do | each |
+        next unless /(.+)=(.+)/=~ each
+        name, value = $1, $2
+        attr_reader name.to_sym
+        if ( /\A\d+\Z/=~ value ) or ( /\A0x.+\Z/=~ value )
+          flow.instance_eval "@#{ name }=#{ value }"
+        else
+          flow.instance_eval "@#{ name }='#{ value }'"
+        end
+      end
+      flow
+    end
+
+
+    def users_flow?
+      not ( ( @actions == "drop" and @priority == 0 ) or
+            @actions == "CONTROLLER:65535" )
+    end
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/ruby/trema/get-config-reply.c

@@ -0,0 +1,159 @@
+/*
+ * 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 cGetConfigReply;
+
+
+/*
+ * Handles the response to +OFPT_GET_CONFIG_REQUEST+ message. The user would not
+ * explicitly instantiate a {GetConfigReply} object but would be created while
+ * parsing the +OFPT_GET_CONFIG_REPLY+ message. The {GetConfigReply} object is 
+ * an object whose attributes represent the return values of the message.
+ *
+ * @overload initialize(options={})
+ *
+ *   @example 
+ *     GetConfigReply.new(
+ *       :datapath_id => 2748
+ *       :transaction_id => 1,
+ *       :flags => 0
+ *       :miss_send_len => 65535
+ *     )
+ *
+ *   @param [Hash] options
+ *     the options to create a message with.
+ *
+ *   @option options [Number] :datapath_id
+ *     message originator identifier.
+ *
+ *   @option options [Number] :transaction_id
+ *     the saved transaction_id from +OFPT_GET_CONFIG_REQUEST+ message.
+ *
+ *   @option options [Number] :flags
+ *     indicates how IP fragments are treated.
+ *
+ *   @option options [Number] :miss_send_len
+ *     the maximum number of bytes to send on a flow table miss or 
+ *     flow destined to controller.
+ *
+ *   @return [GetConfigReply] 
+ *     an object that encapsulates the +OFPT_GET_CONFIG_REPLY+ OpenFlow message.   
+ */
+static VALUE
+get_config_reply_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
+get_config_reply_datapath_id( VALUE self ) {
+  return rb_hash_aref( rb_iv_get( self, "@attribute" ), ID2SYM( rb_intern( "datapath_id" ) ) );
+}
+
+
+/*
+ * Transaction ids, message sequence numbers matching requests to replies.
+ *
+ * @return [Number] the value of transaction id.
+ */
+static VALUE
+get_config_reply_transaction_id( VALUE self ) {
+  return rb_hash_aref( rb_iv_get( self, "@attribute" ), ID2SYM( rb_intern( "transaction_id" ) ) );
+}
+
+
+/*
+ * Flags indicate how IP fragments should be treated (no special handling,
+ * dropped or reassembled).
+ *
+ * @return [Number] the value of flags.
+ */
+static VALUE
+get_config_reply_flags( VALUE self ) {
+  return rb_hash_aref( rb_iv_get( self, "@attribute" ), ID2SYM( rb_intern( "flags" ) ) );
+}
+
+
+/*
+ * The maximum number of bytes to send on flow table miss or flow destined to controller.
+ *
+ * @return [Number] the value of miss_send_len.
+ */
+static VALUE
+get_config_reply_miss_send_len( VALUE self ) {
+  return rb_hash_aref( rb_iv_get( self, "@attribute" ), ID2SYM( rb_intern( "miss_send_len" ) ) );
+}
+
+
+void
+Init_get_config_reply() {
+  cGetConfigReply = rb_define_class_under( mTrema, "GetConfigReply", rb_cObject );
+  rb_define_method( cGetConfigReply, "initialize", get_config_reply_init, 1 );
+  rb_define_method( cGetConfigReply, "datapath_id", get_config_reply_datapath_id, 0 );
+  rb_define_method( cGetConfigReply, "transaction_id", get_config_reply_transaction_id, 0 );
+  rb_define_method( cGetConfigReply, "flags", get_config_reply_flags, 0 );
+  rb_define_method( cGetConfigReply, "miss_send_len", get_config_reply_miss_send_len, 0 );
+}
+
+
+/*
+ * Handler called when +OFPT_GET_CONFIG_REPLY+ message is received.
+ */
+void
+handle_get_config_reply(
+  uint64_t datapath_id,
+  uint32_t transaction_id,
+  uint16_t flags,
+  uint16_t miss_send_len,
+  void *user_data
+) {
+  VALUE controller = ( VALUE ) user_data;
+  if ( rb_respond_to( controller, rb_intern( "get_config_reply" ) ) == 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( "flags" ) ), UINT2NUM( flags ) );
+  rb_hash_aset( attributes, ID2SYM( rb_intern( "miss_send_len" ) ), UINT2NUM( miss_send_len ) );
+
+  VALUE get_config_reply = rb_funcall( cGetConfigReply, rb_intern( "new" ), 1, attributes );
+  rb_funcall( controller, rb_intern( "get_config_reply" ), 1, get_config_reply );
+}
+
+
+/*
+ * Local variables:
+ * c-basic-offset: 2
+ * indent-tabs-mode: nil
+ * End:
+ */

data/ruby/trema/get-config-reply.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 GET_CONFIG_REPLY_H
+#define GET_CONFIG_REPLY_H
+
+
+#include "ruby.h"
+#include "trema.h"
+
+
+extern VALUE cGetConfigReply;
+
+
+void Init_get_config_reply( void );
+
+
+void handle_get_config_reply(
+        uint64_t datapath_id,
+        uint32_t transaction_id,
+        uint16_t flags,
+        uint16_t miss_send_len,
+        void *user_data
+        );
+
+
+#endif // GET_CONFIG_REPLY_H
+
+
+/*
+ * Local variables:
+ * c-basic-offset: 2
+ * indent-tabs-mode: nil
+ * End:
+ */

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

@@ -0,0 +1,107 @@
+/*
+ * 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 cGetConfigRequest;
+
+
+static VALUE
+get_config_request_alloc( VALUE klass ) {
+  buffer *get_config_request = create_get_config_request( get_transaction_id() );
+  return Data_Wrap_Struct( klass, NULL, free_buffer, get_config_request );
+}
+
+
+/*
+ * Creates a {GetConfigRequest} instance to query configuration parameters 
+ * from the switch.
+ *
+ * @overload initialize(options={})
+ *   @example
+ *     GetConfigRequest.new
+ *     GetConfigRequest.new( :transaction_id => 123 )
+ *
+ *   @param [Hash] options
+ *     the options to create a message with.
+ *
+ *   @option options [Number] :transaction_id
+ *     An unsigned 32-bit integer auto-generated if not supplied.
+ *
+ *   @raise [ArgumentError] if transaction id is not an unsigned 32-bit integer.
+ *   @raise [TypeError] if options is not a hash.
+ *
+ *   @return [GetConfigRequest]
+ *     an object that encapsulates the +OFPT_GET_CONFIG+ OpenFlow message.
+ */
+static VALUE
+get_config_request_init( int argc, VALUE *argv, VALUE self ) {
+  buffer *get_config_request;
+  Data_Get_Struct( self, buffer, get_config_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 * ) ( get_config_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
+get_config_request_transaction_id( VALUE self ) {
+  buffer *get_config_request;
+  Data_Get_Struct( self, buffer, get_config_request );
+  uint32_t xid = ntohl( ( ( struct ofp_header * ) ( get_config_request->data ) )->xid );
+  return UINT2NUM( xid );
+}
+
+
+void
+Init_get_config_request() {
+  cGetConfigRequest = rb_define_class_under( mTrema, "GetConfigRequest", rb_cObject );
+  rb_define_alloc_func( cGetConfigRequest, get_config_request_alloc );
+  rb_define_method( cGetConfigRequest, "initialize", get_config_request_init, -1 );
+  rb_define_method( cGetConfigRequest, "transaction_id", get_config_request_transaction_id, 0 );
+}
+
+
+/*
+ * Local variables:
+ * c-basic-offset: 2
+ * indent-tabs-mode: nil
+ * End:
+ */