trema 0.1.3

data/ruby/trema/action-enqueue.h

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

data/ruby/trema/action-output.c

@@ -0,0 +1,169 @@
+/*
+ * 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 cActionOutput;
+
+
+/*
+ * An action to output a packet to a port.
+ *
+ * @overload initialize(options={})
+ *
+ *   @example
+ *     ActionOutput.new( 1 )
+ *     ActionOutput.new( :port => 1, :max_len => 256 )
+ *     ActionOutput.new( :port => 1 )
+ *     ActionOutput.new( :port => 1, :max_len => 256 )
+ *
+ *   @param [Hash] options
+ *     the options hash to create this action class instance with.
+ *
+ *   @option options [Number] :port
+ *     port number an index into switch's physical port list. There are also 
+ *     fake output ports. For example a port number set to +OFPP_FLOOD+ would 
+ *     output packets to all physical ports except input port and ports 
+ *     disabled by STP.
+ *
+ *   @option options [Number] :max_len
+ *     the maximum number of bytes from a packet to send to controller when port
+ *     is set to +OFPP_CONTROLLER+. A zero length means no bytes of the packet
+ *     should be sent. It defaults to 64K.
+ *
+ *   @raise [ArgumentError] if port is not an unsigned 16-bit integer.
+ *   @raise [ArgumentError] if max_len is not an unsigned 16-bit integer.
+ *
+ *   @return [ActionOutput] self
+ *     an object that encapsulates this action.
+ */
+static VALUE
+action_output_init( VALUE self, VALUE options ) {
+  if ( rb_obj_is_kind_of( options, rb_cHash ) ) {
+    VALUE port;
+    if ( ( port = rb_hash_aref( options, ID2SYM( rb_intern( "port" ) ) ) ) != Qnil ) {
+      if ( rb_funcall( port, rb_intern( "unsigned_16bit?" ), 0 ) == Qfalse ) {
+        rb_raise( rb_eArgError, "Port must be an unsigned 16-bit integer" );
+      }
+      rb_iv_set( self, "@port", port );
+    }
+    else {
+      rb_raise( rb_eArgError, "Port is a mandatory option" );
+    }
+    VALUE max_len;
+    if ( ( max_len = rb_hash_aref( options, ID2SYM( rb_intern( "max_len" ) ) ) ) != Qnil ) {
+      if ( rb_funcall( max_len, rb_intern( "unsigned_16bit?" ), 0 ) == Qfalse ) {
+        rb_raise( rb_eArgError, "Maximum length must be an unsigned 16-bit integer" );
+      }
+    }
+    else {
+      max_len = UINT2NUM( UINT16_MAX );
+    }
+    rb_iv_set( self, "@max_len", max_len );
+  }
+  else if ( rb_obj_is_kind_of( options, rb_cInteger ) ) {
+    if ( rb_funcall( options, rb_intern( "unsigned_16bit?" ), 0 ) == Qfalse ) {
+      rb_raise( rb_eArgError, "Port must be an unsigned 16-bit integer" );
+    }
+    rb_iv_set( self, "@port", options );
+    rb_iv_set( self, "@max_len", UINT2NUM( UINT16_MAX ) );
+  }
+  else {
+    rb_raise( rb_eArgError, "Invalid option" );
+  }
+  return self;
+}
+
+
+/*
+ * The index into switch's physical port list.
+ *
+ * @return [Number] the value of port.
+ */
+static VALUE
+action_output_port( VALUE self ) {
+  return rb_iv_get( self, "@port" );
+}
+
+
+/*
+ * The maximum number of bytes from a packet to send to controller when port
+ * is set to +OFPP_CONTROLLER+.
+ *
+ * @return [Number] the value of max_len.
+ */
+static VALUE
+action_output_max_len( VALUE self ) {
+  return rb_iv_get( self, "@max_len" );
+}
+
+
+/*
+ * Appends its action(output to port) to the list of actions.
+ *
+ * @return [ActionOutput] self
+ */
+static VALUE
+action_output_append( VALUE self, VALUE action_ptr ) {
+  uint16_t port = ( uint16_t ) NUM2UINT( action_output_port( self ) );
+  uint16_t max_len = ( uint16_t ) NUM2UINT( action_output_max_len( self ) );
+
+  openflow_actions *actions;
+  Data_Get_Struct( action_ptr, openflow_actions, actions );
+
+  append_action_output( actions, port, max_len );
+  return self;
+}
+
+
+/*
+ * (see ActionEnqueue#inspect)
+ */
+static VALUE
+action_output_inspect( VALUE self ) {
+  uint16_t port = ( uint16_t ) NUM2UINT( action_output_port( self ) );
+  uint16_t max_len = ( uint16_t ) NUM2UINT( action_output_max_len( self ) );
+
+  char str[ 64 ];
+  sprintf( str, "#<%s port=%u,max_len=%u>", rb_obj_classname( self ), port, max_len );
+  return rb_str_new2( str );
+}
+
+
+void
+Init_action_output() {
+  cActionOutput = rb_define_class_under( mTrema, "ActionOutput", rb_cObject );
+  rb_define_method( cActionOutput, "initialize", action_output_init, 1 );
+  rb_define_method( cActionOutput, "port", action_output_port, 0 );
+  rb_define_method( cActionOutput, "max_len", action_output_max_len, 0 );
+  rb_define_method( cActionOutput, "append", action_output_append, 1 );
+  rb_define_method( cActionOutput, "inspect", action_output_inspect, 0 );
+}
+
+
+/*
+ * Local variables:
+ * c-basic-offset: 2
+ * indent-tabs-mode: nil
+ * End:
+ */

data/ruby/trema/action-output.h

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

data/ruby/trema/action-set-dl-dst.c

@@ -0,0 +1,131 @@
+/*
+ * 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"
+#include "action-common.h"
+
+
+extern VALUE mTrema;
+VALUE cActionSetDlDst;
+
+
+/*
+ * An action to modify the destination Ethernet address of a packet.
+ *
+ * @overload initialize(options={})
+ *
+ *   @example
+ *     ActionSetDlDst.new( :dl_dst => Mac.new( "11:22:33:44:55:66" )
+ *     ActionSetDlDst.new( :dl_dst => Mac.new( 0x112233445566 )
+ *
+ *   @param [Hash] options
+ *     the options hash to create this action class instance with.
+ *
+ *   @option options [Mac] :dl_dst
+ *     a destination Ethernet address encapsulated as a {Mac} object.
+ *
+ *   @raise [ArgumentError] if dl_dst argument is not supplied.
+ *   @raise [TypeError] if dl_dst argument is not a {Mac} object instance.
+ *   @raise [TypeError] if options is not a Hash.
+ *
+ *   @return [ActionSetDlDst] self
+ *     an object that encapsulates this action.
+ */
+static VALUE
+action_set_dl_dst_init( int argc, VALUE *argv, VALUE self ) {
+  VALUE options;
+
+  if ( rb_scan_args( argc, argv, "10", &options ) == 1 ) {
+    Check_Type( options, T_HASH );
+    VALUE dl_dst;
+    if ( ( dl_dst = rb_hash_aref( options, ID2SYM( rb_intern( "dl_dst" ) ) ) ) != Qnil ) {
+      if ( rb_obj_is_instance_of( dl_dst, rb_eval_string( "Trema::Mac" ) ) == Qfalse ) {
+        rb_raise( rb_eTypeError, "dl dst address should be a Mac object" );
+      }
+      rb_iv_set( self, "@dl_dst", dl_dst );
+    }
+    else {
+      rb_raise( rb_eArgError, "dl dst address is a mandatory option" );
+    }
+  }
+  return self;
+}
+
+
+/*
+ * A destination Ethernet address encapsulated as a {Mac} object.
+ *
+ * @return [Mac] the value of dl_dst.
+ */
+static VALUE
+action_get_dl_dst( VALUE self ) {
+  return rb_iv_get( self, "@dl_dst" );
+}
+
+
+/*
+ * Appends its action(set_dl_dst) to the list of actions.
+ *
+ * @return [ActionSetDlDst] self
+ */
+static VALUE
+action_set_dl_dst_append( VALUE self, VALUE action_ptr ) {
+  openflow_actions *actions;
+  Data_Get_Struct( action_ptr, openflow_actions, actions );
+  
+  uint8_t dl_dst[ OFP_ETH_ALEN ];
+  uint8_t *ptr;
+  ptr = ( uint8_t* ) dl_addr_short( action_get_dl_dst( self ), dl_dst );
+  append_action_set_dl_dst( actions, ptr );
+  return self;
+}
+
+
+/*
+ * (see ActionEnqueue#inspect)
+ */
+static VALUE
+action_set_dl_dst_inspect( VALUE self ) {
+  VALUE mac_obj = action_get_dl_dst( self );
+  VALUE dl_dst_str = rb_funcall( mac_obj, rb_intern( "to_s" ), 0 );
+  
+  char str[ 64 ];
+  sprintf( str, "#<%s dl_dst=%s>", rb_obj_classname( self ), RSTRING_PTR( dl_dst_str ) );
+  return rb_str_new2( str );
+}
+
+
+void
+Init_action_set_dl_dst() {
+  cActionSetDlDst = rb_define_class_under( mTrema, "ActionSetDlDst", rb_cObject );
+  rb_define_method( cActionSetDlDst, "initialize", action_set_dl_dst_init, -1 );
+  rb_define_method( cActionSetDlDst, "dl_dst", action_get_dl_dst, 0 );
+  rb_define_method( cActionSetDlDst, "append", action_set_dl_dst_append, 1 );
+  rb_define_method( cActionSetDlDst, "inspect", action_set_dl_dst_inspect, 0 );
+}
+
+
+/*
+ * Local variables:
+ * c-basic-offset: 2
+ * indent-tabs-mode: nil
+ * End:
+ */

data/ruby/trema/action-set-dl-dst.h

@@ -0,0 +1,44 @@
+/*
+ * Prototype for setting the destination data link address flow action.
+ *
+ * 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_SET_DL_DST_H
+#define ACTION_SET_DL_DST_H
+
+
+#include "ruby.h"
+
+
+extern VALUE cActionSetDlDst;
+
+
+void Init_action_set_dl_dst( void );
+
+
+#endif // ACTION_SET_DL_DST_H
+
+
+/*
+ * Local variables:
+ * c-basic-offset: 2
+ * indent-tabs-mode: nil
+ * End:
+ */

data/ruby/trema/action-set-dl-src.c

@@ -0,0 +1,131 @@
+/*
+ * 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"
+#include "action-common.h"
+
+
+extern VALUE mTrema;
+VALUE cActionSetDlSrc;
+
+
+/*
+ * An action to modify the source Ethernet address of a packet.
+ *
+ * @overload initialize(options={})
+ *
+ *   @example
+ *     ActionSetDlSrc.new( :dl_src => Mac.new( "11:22:33:44:55:66" )
+ *     ActionSetDlSrc.new( :dl_src => Mac.new( 0x112233445566 )
+ *
+ *   @param [Hash] options
+ *     the options hash to create this action class instance with.
+ *
+ *   @option options [Mac] :dl_src
+ *     a source Ethernet address encapsulated as a {Mac} object.
+ *
+ *   @raise [ArgumentError] if dl_src argument is not supplied.
+ *   @raise [TypeError] if dl_src argument is not a {Mac} object instance.
+ *   @raise [TypeError] if options is not a Hash.
+ *
+ *   @return [ActionSetDlSrc] self
+ *     an object that encapsulates this action.
+ */
+static VALUE
+action_set_dl_src_init( int argc, VALUE *argv, VALUE self ) {
+  VALUE options;
+
+  if ( rb_scan_args( argc, argv, "10", &options ) == 1 ) {
+    Check_Type( options, T_HASH );
+    VALUE dl_src;
+    if ( ( dl_src = rb_hash_aref( options, ID2SYM( rb_intern( "dl_src" ) ) ) ) != Qnil ) {
+      if ( rb_obj_is_instance_of( dl_src, rb_eval_string( "Trema::Mac" ) ) == Qfalse ) {
+        rb_raise( rb_eTypeError, "dl src address should be a Mac object" );
+      }
+      rb_iv_set( self, "@dl_src", dl_src );
+    }
+    else {
+      rb_raise( rb_eArgError, "dl src address is a mandatory option" );
+    }
+  }
+  return self;
+}
+
+
+/*
+ * A source Ethernet address encapsulated as a {Mac} object.
+ *
+ * @return [Mac] the value of dl_src.
+ */
+static VALUE
+action_get_dl_src( VALUE self ) {
+  return rb_iv_get( self, "@dl_src" );
+}
+
+
+/*
+ * Appends its action(set_dl_src) to the list of actions.
+ *
+ * @return [ActionSetDlSrc] self
+ */
+static VALUE
+action_set_dl_src_append( VALUE self, VALUE action_ptr ) {
+  openflow_actions *actions;
+  Data_Get_Struct( action_ptr, openflow_actions, actions );
+
+  uint8_t dl_src[ OFP_ETH_ALEN ];
+  uint8_t *ptr;
+  ptr = ( uint8_t* ) dl_addr_short( action_get_dl_src( self ), dl_src );
+  append_action_set_dl_src( actions, ptr );
+  return self;
+}
+
+
+/*
+ * (see ActionEnqueue#inspect)
+ */
+static VALUE
+action_set_dl_src_inspect( VALUE self ) {
+  VALUE mac_obj = action_get_dl_src( self );
+  
+  VALUE dl_src_str = rb_funcall( mac_obj, rb_intern( "to_s" ), 0 );
+  char str[ 64 ];
+  sprintf( str, "#<%s dl_src=%s>", rb_obj_classname( self ), RSTRING_PTR( dl_src_str ) );
+  return rb_str_new2( str );
+}
+
+
+void
+Init_action_set_dl_src() {
+  cActionSetDlSrc = rb_define_class_under( mTrema, "ActionSetDlSrc", rb_cObject );
+  rb_define_method( cActionSetDlSrc, "initialize", action_set_dl_src_init, -1 );
+  rb_define_method( cActionSetDlSrc, "dl_src", action_get_dl_src, 0 );
+  rb_define_method( cActionSetDlSrc, "append", action_set_dl_src_append, 1 );
+  rb_define_method( cActionSetDlSrc, "inspect", action_set_dl_src_inspect, 0 );
+}
+
+
+/*
+ * Local variables:
+ * c-basic-offset: 2
+ * indent-tabs-mode: nil
+ * End:
+ */