trema 0.1.3

data/ruby/trema/packet_in.h

@@ -0,0 +1,46 @@
+/*
+ * Ruby wrapper class of OpenFlow packet_in 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 PACKET_IN_H
+#define PACKET_IN_H
+
+
+#include "ruby.h"
+#include "trema.h"
+
+
+extern VALUE cPacketIn;
+
+
+void Init_packet_in( void );
+void handle_packet_in( uint64_t datapath_id, packet_in message );
+
+
+#endif // PACKET_IN_H
+
+
+/*
+ * Local variables:
+ * c-basic-offset: 2
+ * indent-tabs-mode: nil
+ * End:
+ */

data/ruby/trema/packetin-filter.rb

@@ -0,0 +1,126 @@
+#
+# 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/network-component"
+
+
+module Trema
+  #
+  # The controller class of packetin_filter.
+  #
+  class PacketinFilter < NetworkComponent
+    #
+    # Creates a PacketinFilter controller
+    #
+    # @example
+    #   Trema::PacketinFilter.new( :lldp => "topology manager", :packet_in => "OpenFlow ping-pong" )
+    #
+    # @return [PacketinFilter]
+    #
+    # @api public
+    #
+    def initialize queues
+      check_mandatory_options queues
+      @queues = queues
+      PacketinFilter.add self
+    end
+
+
+    #
+    # Returns the name of packetin filter
+    #
+    # @example
+    #   packetin_filter.name => "packet-in filter"
+    #
+    # @return [String]
+    #
+    # @api public
+    #
+    def name
+      "packet-in filter"
+    end
+    
+
+    #
+    # Starts a packetin filter process
+    #
+    # @example
+    #   packetin_filter.run!
+    #
+    # @return [undefined]
+    #
+    # @api public
+    #
+    def run!
+      sh "#{ Executables.packetin_filter } --daemonize --name=filter #{ lldp_queue } #{ packetin_queue }"
+    end
+
+
+    ################################################################################
+    private
+    ################################################################################
+
+
+    #
+    # Checks mandatory options for packetin_filter command
+    #
+    # @return [undefined]
+    #
+    # @api private
+    #
+    def check_mandatory_options queues
+      [ :lldp, :packet_in ].each do | each |
+        raise ":#{ each } is a mandatory option" if queues[ each ].nil?
+      end
+    end
+
+
+    #
+    # The lldp option of packetin_filter command
+    #
+    # @return [String]
+    #
+    # @api private
+    #
+    def lldp_queue
+      "lldp::#{ @queues[ :lldp ] }"
+    end
+
+
+    #
+    # The packetin option of packetin_filter command
+    #
+    # @return [String]
+    #
+    # @api private
+    #
+    def packetin_queue
+      "packet_in::#{ @queues[ :packet_in ] }"
+    end
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/ruby/trema/path.rb

@@ -0,0 +1,135 @@
+#
+# Trema paths.
+#
+# 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
+  def self.home
+    File.expand_path File.join( File.dirname( __FILE__ ), "..", ".." )
+  end
+
+
+  def self.objects
+    File.join home, "objects"
+  end
+
+
+  def self.cmockery
+    File.join objects, "cmockery"
+  end
+
+
+  def self.openvswitch
+    File.join objects, "openvswitch"
+  end
+
+
+  def self.cmockery_h
+    File.join cmockery, "include/google/cmockery.h"
+  end
+
+
+  def self.libcmockery_a
+    File.join cmockery, "lib/libcmockery.a"
+  end
+
+
+  def self.openflow
+    File.join objects, "openflow"
+  end
+
+
+  def self.openflow_h
+    File.join openflow, "openflow.h"
+  end
+
+
+  def self.oflops
+    File.join objects, "oflops"
+  end
+
+
+  def self.tmp
+    if ENV.key?( "TREMA_TMP" )
+      File.expand_path ENV[ "TREMA_TMP" ]
+    else
+      File.join home, "tmp"
+    end
+  end
+
+
+  def self.log_directory
+    File.join tmp, "log"
+  end
+
+
+  def self.pid_directory
+    File.join tmp, "pid"
+  end
+
+
+  def self.sock_directory
+    File.join tmp, "sock"
+  end
+
+
+  module Vendor
+    def self.path
+      File.join Trema.home, "vendor"
+    end
+
+
+    def self.cmockery
+      File.join path, "cmockery-20110428"
+    end
+
+
+    def self.openflow
+      File.join path, "openflow-1.0.0"
+    end
+
+
+    def self.openflow_wireshark_plugin
+      File.join path, "openflow.git"
+    end
+
+
+    def self.openvswitch
+      File.join path, "openvswitch-1.2.2"
+    end
+
+
+    def self.phost
+      File.join path, "phost"
+    end
+
+
+    def self.oflops
+      File.join path, "oflops-0.03"
+    end
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8
+### indent-tabs-mode: nil
+### End:

data/ruby/trema/phost.rb

@@ -0,0 +1,69 @@
+#
+# The controller class of phost.
+#
+# 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"
+
+
+module Trema
+  class Phost
+    include Trema::Daemon
+
+
+    command { | phost | "sudo #{ Executables.phost } -i #{ phost.interface } -D" }
+    wait_until_up
+    daemon_id :interface
+
+
+    def initialize host
+      @host = host
+    end
+
+
+    def interface
+      raise "The link(s) for vhost '#{ name }' is not defined." if @host.interface.nil?
+      @host.interface
+    end
+
+
+    def running?
+      not @host.interface.nil? and super
+    end
+
+
+    ################################################################################
+    private
+    ################################################################################
+
+
+    def name
+      @host.name
+    end
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/ruby/trema/port-mod.c

@@ -0,0 +1,226 @@
+/*
+ * 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 cPortMod;
+
+
+static VALUE
+port_mod_alloc( VALUE kclass ) {
+  buffer *port_mod;
+  static const uint8_t hw_addr[ OFP_ETH_ALEN ] = { 0x01, 0x02, 0x03, 0x04, 0x05, 0x06 };
+  uint32_t config = OFPPC_PORT_DOWN;
+  uint32_t mask = 1;
+  uint32_t advertise = 0;
+
+  port_mod = create_port_mod( 1, 1, hw_addr, config, mask, advertise );
+  return Data_Wrap_Struct( kclass, NULL, free_buffer, port_mod );
+}
+
+
+/*
+ * A {PortMod} instance a request object to perform operations on a physical port.
+ *
+ * @overload initialize(options={})
+ *   @example
+ *     PortMod.new(
+ *       :port_no => 1, 
+ *       :hw_addr => "11:22:33:44:55:66",
+ *       :config => 1,
+ *       :mask => 1,
+ *       :advertise => 0
+ *     )
+ *
+ *   @param [Hash] options
+ *     the options to create a message with.
+ *
+ *   @param [Number] :port_no 
+ *     an index into datapath's ports list.
+ *
+ *   @param [String,Number,Trema::Mac] :hw_addr
+ *     the hardware address of a port.
+ *     Unique for each port. Obtained from +OFPT_FEATURES_REPLY+ message.
+ *     Can be supplied as a string, number or as a Mac object.
+ *
+ *   @param [Number] :config 
+ *     a bitmap that can be set to configure a port.
+ *
+ *   @param [Number] :mask 
+ *     set the bits of the +config+ flag to change.
+ *
+ *   @param [Number] :advertise
+ *     bitmap of +ofp_port_features+ set to zero to prevent
+ *     any changes. Or can be copied from +OFPT_FEATURES_REPLY+ message.
+ *
+ *   @return [PortMod]
+ *     an object that encapsulates the +OFPT_PORT_MOD+ OpenFlow message.
+ */
+static VALUE
+port_mod_init( int argc, VALUE *argv, VALUE self ) {
+  VALUE options;
+
+  if ( rb_scan_args( argc, argv, "01", &options ) == 1 ) {
+    Check_Type( options, T_HASH );
+    buffer *port_mod;
+    Data_Get_Struct( self, buffer, port_mod );
+    VALUE mac;
+    VALUE hw_addr;
+    uint8_t *ptr;
+    uint8_t haddr[ OFP_ETH_ALEN ];
+
+    if ( ( hw_addr = rb_hash_aref( options, ID2SYM( rb_intern( "hw_addr" ) ) ) ) != Qnil ) {
+      mac = hw_addr;
+      if ( rb_obj_is_kind_of( hw_addr, rb_cString ) == Qtrue ||
+        rb_obj_is_kind_of( hw_addr, rb_cInteger ) == Qtrue ) {
+        mac = rb_funcall( rb_eval_string( "Trema::Mac" ), rb_intern( "new" ), 1, hw_addr );
+      } else if ( rb_obj_is_instance_of( hw_addr, rb_eval_string( "Trema::Mac" ) ) == Qfalse ) {
+        rb_raise( rb_eArgError, "hw_addr must be a string or an integer or Mac object" );
+      }
+      ptr = ( uint8_t* ) dl_addr_short( mac, haddr );
+      rb_iv_set( self, "@hw_addr", mac );
+    }
+    VALUE port_no;
+    if ( ( port_no = rb_hash_aref( options, ID2SYM( rb_intern( "port_no" ) ) ) ) != Qnil ) {
+      if ( rb_funcall( port_no, rb_intern( "unsigned_16bit?" ), 0 ) == Qfalse ) {
+        rb_raise( rb_eArgError, "Port number must be an unsigned 16-bit integer" );
+      }
+      rb_iv_set( self, "@port_no", port_no );
+    }
+    VALUE config;
+    if ( ( config = rb_hash_aref( options, ID2SYM( rb_intern( "config" ) ) ) ) != Qnil ){
+      rb_iv_set( self, "@config", config );
+    }
+    VALUE  mask;
+    if ( ( mask = rb_hash_aref( options, ID2SYM( rb_intern( "mask" ) ) ) ) != Qnil ){
+      rb_iv_set( self, "@mask", mask );
+    }
+    VALUE advertise;
+    if ( ( advertise = rb_hash_aref( options, ID2SYM( rb_intern( "advertise" ) ) ) ) != Qnil ){
+      rb_iv_set( self, "@advertise", advertise );
+    }
+    uint32_t xid = get_transaction_id();
+    rb_iv_set( self, "@transaction_id", UINT2NUM( xid ) );
+
+    ( ( struct ofp_header * ) ( port_mod->data ) )->xid = htonl( xid );
+    ( ( struct ofp_port_mod * ) ( port_mod->data ) )->port_no = htons( ( uint16_t ) NUM2UINT( port_no ) );
+    memcpy( ( ( struct ofp_port_mod * ) ( port_mod->data ) )->hw_addr, ptr, OFP_ETH_ALEN );
+    ( ( struct ofp_port_mod * ) ( port_mod->data ) )->config = htonl( ( uint32_t ) NUM2UINT( config ) );
+    ( ( struct ofp_port_mod * ) ( port_mod->data ) )->mask = htonl( ( uint32_t ) NUM2UINT( mask ) );
+    ( ( struct ofp_port_mod * ) ( port_mod->data ) )->advertise = htonl( ( uint32_t ) NUM2UINT( advertise ) );
+  }
+  else {
+    rb_raise( rb_eArgError, "Port no, hw_addr, config, mask, advertise are mandatory options" );
+  }
+  return self;
+}
+
+
+/*
+ * Transaction ids, message sequence numbers matching requests to replies.
+ *
+ * @return [Number] the value of transaction_id.
+ */
+static VALUE
+port_mod_transaction_id( VALUE self ) {
+  return rb_iv_get( self, "@transaction_id" );
+}
+
+
+/*
+ * Port number and hardware address as a pair identify a port.
+ *
+ * @return [Number] the value of port_no.
+ */
+static VALUE
+port_mod_port_no( VALUE self ) {
+  return rb_iv_get( self, "@port_no" );
+}
+
+
+/*
+ * Ethernet address converted and stored as a {Trema::Mac} object.
+ *
+ * @return [Mac] the value of hw_addr.
+ */
+static VALUE
+port_mod_hw_addr( VALUE self ) {
+  return rb_iv_get( self, "@hw_addr" );
+}
+
+
+/*
+ * A port can be administratively brought down, disable flooding or packet 
+ * forwarding or any other options as per +ofp_port_config+. flags.
+ *
+ * @return [Number] the value of config.
+ */
+static VALUE
+port_mod_config( VALUE self ) {
+  return rb_iv_get( self, "@config" );
+}
+
+
+/*
+ * Set the bitmap as per +config+ attribute.
+ *
+ * @return [Number] the value of mask.
+ */
+static VALUE
+port_mod_mask( VALUE self ) {
+  return rb_iv_get( self, "@mask" );
+}
+
+
+/*
+ * Set to zero to prevent any changes.
+ *
+ * @return [Number] the value of advertise. 
+ */
+static VALUE
+port_mod_advertise( VALUE self ) {
+  return rb_iv_get( self, "@advertise" );
+}
+
+
+void
+Init_port_mod() {
+  cPortMod = rb_define_class_under( mTrema, "PortMod", rb_cObject );
+  rb_define_alloc_func( cPortMod, port_mod_alloc );
+  rb_define_method( cPortMod, "initialize", port_mod_init, -1 );
+  rb_define_method( cPortMod, "transaction_id", port_mod_transaction_id, 0 );
+  rb_define_method( cPortMod, "port_no", port_mod_port_no, 0 );
+  rb_define_method( cPortMod, "hw_addr", port_mod_hw_addr, 0 );
+  rb_define_method( cPortMod, "config", port_mod_config, 0 );
+  rb_define_method( cPortMod, "mask", port_mod_mask, 0 );
+  rb_define_method( cPortMod, "advertise", port_mod_advertise, 0 );
+}
+
+
+/*
+ * Local variables:
+ * c-basic-offset: 2
+ * indent-tabs-mode: nil
+ * End:
+ */