trema 0.1.3

data/src/examples/dumper/dumper.conf

@@ -0,0 +1,7 @@
+vswitch("dumper") { datapath_id "0xabc" }
+
+vhost("host1")
+vhost("host2")
+
+link "dumper", "host1"
+link "dumper", "host2"

data/src/examples/dumper/dumper.rb

@@ -0,0 +1,196 @@
+#
+# Openflow message event dumper.
+#
+# 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.
+#
+
+
+class Dumper < Controller
+  def switch_disconnected datapath_id
+    info "[switch_disconnected]"
+    info "  datapath_id: #{ datapath_id.to_hex }"
+  end
+
+
+  def packet_in datapath_id, message
+    info "[packet_in]"
+    info "  datapath_id: #{ datapath_id.to_hex }"
+    info "  transaction_id: #{ message.transaction_id.to_hex }"
+    info "  buffer_id: #{ message.buffer_id.to_hex }"
+    info "  total_len: #{ message.total_len }"
+    info "  in_port: #{ message.in_port }"
+    info "  reason: #{ message.reason.to_hex }"
+    info "  data: #{ message.data.unpack "H*" }"
+  end
+
+
+  def flow_removed datapath_id, message
+    info "[flow_removed]"
+    info "datapath_id: #{ datapath_id.to_hex }"
+    info "transaction_id: #{ message.transaction_id.to_hex }"
+
+    info "match:"
+    info "  wildcards: #{ message.match.wildcards.to_hex }"
+    info "  in_port: #{ message.match.in_port }"
+    info "  dl_src: #{ message.match.dl_src }"
+    info "  dl_dst: #{ message.match.dl_dst }"
+    info "  dl_vlan: #{ message.match.dl_vlan }"
+    info "  dl_vlan_pcp: #{ message.match.dl_vlan_pcp }"
+    info "  dl_type: #{ message.match.dl_type.to_hex }"
+    info "  nw_tos: #{ message.match.nw_tos }"
+    info "  nw_proto: #{ message.match.nw_proto.to_hex }"
+    info "  nw_src: #{ message.match.nw_src.to_hex }"
+    info "  nw_dst: #{ message.match.nw_dst.to_hex }"
+    info "  tp_src: #{ message.match.tp_src }"
+    info "  tp_dst: #{ message.match.tp_dst }"
+
+    info "cookie: #{ message.cookie.to_hex }"
+    info "priority: #{ message.priority }"
+    info "reason: #{ message.reason.to_hex }"
+    info "duration_sec: #{ message.duration_sec }"
+    info "duration_nsec: #{ message.duration_nsec }"
+    info "idle_timeout: #{ message.idle_timeout }"
+    info "packet_count: #{ message.packet_count.to_hex }"
+    info "byte_count: #{ message.byte_count.to_hex }"
+  end
+
+
+  def get_config_reply message
+    info "[get_config_reply]"
+    info "datapath_id: #{ message.datapath_id.to_hex }"
+    info "transaction_id: #{ message.transaction_id.to_hex }"
+    info "flags: #{ message.flags.to_hex }"
+    info "miss_send_len: #{ message.miss_send_len }"
+  end
+
+
+  def port_status message
+    info "[port_status]"
+    info "datapath_id: #{ message.datapath_id.to_hex }"
+    info "transaction_id: #{ message.transaction_id.to_hex }"
+    info "reason: #{ message.reason.to_hex }"
+    dump_phy_port message.phy_port
+  end
+
+
+  def stats_reply message
+    info "[stats_reply]"
+    info "datapath_id: #{ message.datapath_id.to_hex }"
+    info "transaction_id: #{ message.transaction_id.to_hex }"
+    info "type: #{ message.type.to_hex }"
+    info "flags: #{ message.flags.to_hex }"
+    message.stats.each { | each | info each.to_s }
+  end
+
+
+  def openflow_error message
+    info "[error]"
+    info "datapath_id: #{ message.datapath_id.to_hex }"
+    info "transaction_id: #{ message.transaction_id.to_hex }"
+    info "type: #{ message.type.to_hex }"
+    info "code: #{ message.code.to_hex }"
+    info "data: #{ message.data.unpack "H*" }"
+  end
+
+
+  def queue_get_config_reply message
+    info "[queue_get_config_reply]"
+    info "datapath_id: #{ message.datapath_id.to_hex }"
+    info "transaction_id: #{ message.transaction_id.to_hex }"
+    info "port: #{ message.port }"
+    info( "queues:" );
+    dump_packet_queue message.queues
+  end
+
+
+  def barrier_reply message
+    info "[barrier_reply]"
+    info "datapath_id: #{ message.datapath_id.to_hex }"
+    info "transaction_id: #{ message.transaction_id.to_hex }"
+  end
+
+
+  def features_reply message
+    info "[features_reply]"
+    info "datapath_id: #{ message.datapath_id.to_hex }"
+    info "transaction_id: #{ message.transaction_id.to_hex }"
+    info "n_buffers: #{ message.n_buffers }"
+    info "n_tables: #{ message.n_tables }"
+    info "capabilities: #{ message.capabilities.to_hex }"
+    info "actions: #{ message.actions.to_hex }"
+    message.ports.each do | each |
+      dump_phy_port each
+    end
+  end
+
+
+  def vendor message
+    info "[vendor]"
+    info "datapath_id: #{ message.datapath_id.to_hex }"
+    info "transaction_id: #{ message.transaction_id.to_hex }"
+    info "data:"
+    info message.buffer.unpack( "H*" )
+  end
+
+
+  def list_switches_reply dpids
+    info "[list_switches_reply]"
+    info "switches = %s" % dpids.collect { | each | each.to_hex }.join( ", " )
+  end
+
+
+  ##############################################################################
+  private
+  ##############################################################################
+
+
+  def dump_phy_port port
+    # for testing port-status record the mac address if port.number == 2.
+    @hw_addr = port.hw_addr if port.number == 2 
+    info "port_no: #{ port.number }"
+    info "  hw_addr: #{ port.hw_addr }"
+    info "  name: #{ port.name }"
+    info "  config: #{ port.config.to_hex }"
+    info "  state: #{ port.state.to_hex }"
+    info "  curr: #{ port.curr.to_hex }"
+    info "  advertised: #{ port.advertised.to_hex }"
+    info "  supported: #{ port.supported.to_hex }"
+    info "  peer: #{ port.peer.to_hex }"
+  end
+
+
+  def dump_packet_queue queues
+    queues.each do | packet_queue |
+      info "queue_id: #{ packet_queue.queue_id.to_hex }"
+      info "  len: #{ packet_queue.len }"
+      info "  properties:"
+      packet_queue.properties.each do | prop |
+        info "    property: #{ prop.property.to_hex }"
+        info "    len: #{ prop.len.to_hex }"
+        info "      rate: %u" % prop.rate if prop.property == PacketQueue::OFPQT_MIN_RATE
+      end
+    end
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/src/examples/hello_trema/README

@@ -0,0 +1,13 @@
+This directory includes minimum examples of Trema controller in C and Ruby.
+
+
+# How to run (C version)
+
+  % ./trema run ./objects/examples/hello_trema/hello_trema -c src/examples/hello_trema/hello_trema.conf
+
+# How to run (Ruby version)
+
+  % ./trema run ./src/examples/hello_trema/hello_trema.rb -c src/examples/hello_trema/hello_trema.conf
+
+
+Enjoy!

data/src/examples/hello_trema/hello_trema.c

@@ -0,0 +1,51 @@
+/*
+ * Hello trema world!
+ *
+ * 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 <inttypes.h>
+#include "trema.h"
+
+
+static void
+handle_switch_ready( uint64_t datapath_id, void *user_data ) {
+  info( "Hello %#" PRIx64 " from %s!", datapath_id, user_data );
+  stop_trema();
+}
+
+
+int
+main( int argc, char *argv[] ) {
+  init_trema( &argc, &argv );
+
+  set_switch_ready_handler( handle_switch_ready, argv[ 0 ] );
+
+  start_trema();
+
+  return 0;
+}
+
+
+/*
+ * Local variables:
+ * c-basic-offset: 2
+ * indent-tabs-mode: nil
+ * End:
+ */

data/src/examples/hello_trema/hello_trema.conf

@@ -0,0 +1,3 @@
+vswitch {
+  datapath_id "0xabc"
+}

data/src/examples/hello_trema/hello_trema.rb

@@ -0,0 +1,35 @@
+#
+# Hello trema world!
+#
+# 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.
+#
+
+
+class HelloController < Controller
+  def switch_ready datapath_id
+    info "Hello %#x from #{ ARGV[ 0 ] }!" % datapath_id
+    shutdown!
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8
+### indent-tabs-mode: nil
+### End:

data/src/examples/learning_switch/README

@@ -0,0 +1,15 @@
+This directory includes an OpenFlow controller that controls a single
+OpenFlow switch and emulates a layer 2 switch.
+
+
+# How to run (C version)
+
+  % ./trema run ./objects/examples/learning_switch/learning_switch -c ./src/examples/learning_switch/learning_switch.conf
+
+
+# How to run (Ruby version)
+
+  % ./trema run ./src/examples/learning_switch/learning-switch.rb -c ./src/examples/learning_switch/learning_switch.conf
+
+
+Enjoy!

data/src/examples/learning_switch/fdb.rb

@@ -0,0 +1,112 @@
+#
+# Forwarding database (FDB)
+#
+# 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.
+#
+
+
+class ForwardingEntry
+  include Trema::Logger
+
+
+  attr_reader :mac
+  attr_reader :port_no
+  attr_reader :dpid
+  attr_writer :age_max
+
+
+  def initialize mac, port_no, age_max, dpid
+    @mac = mac
+    @port_no = port_no
+    @age_max = age_max
+    @dpid = dpid
+    @last_update = Time.now
+    debug "New entry: MAC address = #{ @mac.to_s }, port number = #{ @port_no }"
+  end
+
+
+  def update port_no
+    debug "Update: The port number of #{ @mac.to_s } has been changed #{ @port_no } => #{ port_no }"
+    @port_no = port_no
+    @last_update = Time.now
+  end
+
+
+  def aged_out?
+    aged_out = Time.now - @last_update > @age_max
+    debug "Age out: An entry (MAC address = #{ @mac.to_s }, port number = #{ @port_no }) has been aged-out" if aged_out
+    aged_out
+  end
+end
+
+
+#
+# A database that keep pairs of MAC address and port number
+#
+class FDB
+  DEFAULT_AGE_MAX = 300
+
+
+  def initialize
+    @db = {}
+  end
+
+
+  def port_no_of mac
+    dest = @db[ mac ]
+    if dest
+      dest.port_no
+    else
+      nil
+    end
+  end
+
+
+  def lookup mac
+    if dest = @db[ mac ]
+      [ dest.dpid, dest.port_no ]
+    else
+      nil
+    end
+  end
+
+
+  def learn mac, port_no, dpid = nil
+    entry = @db[ mac ]
+    if entry
+      entry.update port_no
+    else
+      new_entry = ForwardingEntry.new( mac, port_no, DEFAULT_AGE_MAX, dpid )
+      @db[ new_entry.mac ] = new_entry
+    end
+  end
+
+
+  def age
+    @db.delete_if do | mac, entry |
+      entry.aged_out?
+    end
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8
+### indent-tabs-mode: nil
+### End:

data/src/examples/learning_switch/learning-switch.rb

@@ -0,0 +1,88 @@
+#
+# Simple learning switch application in Ruby
+#
+# 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 "fdb"
+
+
+#
+# A OpenFlow controller class that emulates a layer-2 switch.
+#
+class LearningSwitch < Trema::Controller
+  add_timer_event :age_fdb, 5, :periodic
+
+
+  def start
+    @fdb = FDB.new
+  end
+
+
+  def packet_in datapath_id, message
+    @fdb.learn message.macsa, message.in_port
+    port_no = @fdb.port_no_of( message.macda )
+    if port_no
+      flow_mod datapath_id, message, port_no
+      packet_out datapath_id, message, port_no
+    else
+      flood datapath_id, message
+    end
+  end
+
+
+  def age_fdb
+    @fdb.age
+  end
+
+
+  ##############################################################################
+  private
+  ##############################################################################
+
+
+  def flow_mod datapath_id, message, port_no
+    send_flow_mod_add(
+      datapath_id,
+      :match => ExactMatch.from( message ),
+      :actions => Trema::ActionOutput.new( :port => port_no )
+    )
+  end
+
+
+  def packet_out datapath_id, message, port_no
+    send_packet_out(
+      datapath_id,
+      :packet_in => message,
+      :actions => Trema::ActionOutput.new( :port => port_no )
+    )
+  end
+
+
+  def flood datapath_id, message
+    packet_out datapath_id, message, OFPP_FLOOD
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8
+### indent-tabs-mode: nil
+### End: