trema 0.1.3

data/src/examples/learning_switch/learning_switch.c

@@ -0,0 +1,236 @@
+/*
+ * Simple learning switch application.
+ *
+ * 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 <time.h>
+#include <assert.h>
+#include "trema.h"
+
+
+typedef struct {
+  struct key {
+    uint8_t mac[ OFP_ETH_ALEN ];
+    uint64_t datapath_id;
+  } key;
+  uint16_t port_no;
+  time_t last_update;
+} forwarding_entry;
+
+
+time_t
+now() {
+  return time( NULL );
+}
+
+
+/********************************************************************************
+ * packet_in event handler
+ ********************************************************************************/
+
+static const int MAX_AGE = 300;
+
+
+static bool
+aged_out( forwarding_entry *entry ) {
+  if ( entry->last_update + MAX_AGE < now() ) {
+    return true;
+  }
+  else {
+    return false;
+  };
+}
+
+
+static void
+age_forwarding_db( void *key, void *forwarding_entry, void *forwarding_db ) {
+  if ( aged_out( forwarding_entry ) ) {
+    delete_hash_entry( forwarding_db, key );
+    xfree( forwarding_entry );
+  }
+}
+
+
+static void
+update_forwarding_db( void *forwarding_db ) {
+  foreach_hash( forwarding_db, age_forwarding_db, forwarding_db );
+}
+
+
+static void
+learn( hash_table *forwarding_db, struct key new_key, uint16_t port_no ) {
+  forwarding_entry *entry = lookup_hash_entry( forwarding_db, &new_key );
+
+  if ( entry == NULL ) {
+    entry = xmalloc( sizeof( forwarding_entry ) );
+    memcpy( entry->key.mac, new_key.mac, OFP_ETH_ALEN );
+    entry->key.datapath_id = new_key.datapath_id;
+    insert_hash_entry( forwarding_db, &entry->key, entry );
+  }
+  entry->port_no = port_no;
+  entry->last_update = now();
+}
+
+
+static void
+do_flooding( packet_in packet_in ) {
+  openflow_actions *actions = create_actions();
+  append_action_output( actions, OFPP_FLOOD, UINT16_MAX );
+
+  buffer *packet_out;
+  if ( packet_in.buffer_id == UINT32_MAX ) {
+    buffer *frame = duplicate_buffer( packet_in.data );
+    fill_ether_padding( frame );
+    packet_out = create_packet_out(
+      get_transaction_id(),
+      packet_in.buffer_id,
+      packet_in.in_port,
+      actions,
+      frame
+    );
+    free_buffer( frame );
+  }
+  else {
+    packet_out = create_packet_out(
+      get_transaction_id(),
+      packet_in.buffer_id,
+      packet_in.in_port,
+      actions,
+      NULL
+    );
+  }
+  send_openflow_message( packet_in.datapath_id, packet_out );
+  free_buffer( packet_out );
+  delete_actions( actions );
+}
+
+
+static void
+send_packet( uint16_t destination_port, packet_in packet_in ) {
+  openflow_actions *actions = create_actions();
+  append_action_output( actions, destination_port, UINT16_MAX );
+
+  struct ofp_match match;
+  set_match_from_packet( &match, packet_in.in_port, 0, packet_in.data );
+
+  buffer *flow_mod = create_flow_mod(
+    get_transaction_id(),
+    match,
+    get_cookie(),
+    OFPFC_ADD,
+    60,
+    0,
+    UINT16_MAX,
+    packet_in.buffer_id,
+    OFPP_NONE,
+    OFPFF_SEND_FLOW_REM,
+    actions
+  );
+  send_openflow_message( packet_in.datapath_id, flow_mod );
+  free_buffer( flow_mod );
+
+  if ( packet_in.buffer_id == UINT32_MAX ) {
+    buffer *frame = duplicate_buffer( packet_in.data );
+    fill_ether_padding( frame );
+    buffer *packet_out = create_packet_out(
+      get_transaction_id(),
+      packet_in.buffer_id,
+      packet_in.in_port,
+      actions,
+      frame
+    );
+    send_openflow_message( packet_in.datapath_id, packet_out );
+    free_buffer( packet_out );
+    free_buffer( frame );
+  }
+
+  delete_actions( actions );
+}
+
+
+static void
+handle_packet_in( uint64_t datapath_id, packet_in message ) {
+  if ( !packet_type_ether( message.data ) ) {
+    return;
+  }
+
+  struct key new_key;
+  packet_info packet_info = get_packet_info( message.data );
+  memcpy( new_key.mac, packet_info.eth_macsa, OFP_ETH_ALEN );
+  new_key.datapath_id = datapath_id;
+  hash_table *forwarding_db = message.user_data;
+  learn( forwarding_db, new_key, message.in_port );
+
+  struct key search_key;
+  memcpy( search_key.mac, packet_info.eth_macda, OFP_ETH_ALEN );
+  search_key.datapath_id = datapath_id;
+  forwarding_entry *destination = lookup_hash_entry( forwarding_db, &search_key );
+
+  if ( destination == NULL ) {
+    do_flooding( message );
+  }
+  else {
+    send_packet( destination->port_no, message );
+  }
+}
+
+
+/********************************************************************************
+ * Start learning_switch controller.
+ ********************************************************************************/
+
+static const int AGING_INTERVAL = 5;
+
+
+unsigned int
+hash_forwarding_entry( const void *key ) {
+  return hash_mac( ( ( const struct key * ) key )->mac );
+}
+
+
+bool
+compare_forwarding_entry( const void *x, const void *y ) {
+  const forwarding_entry *ex = x;
+  const forwarding_entry *ey = y;
+  return ( memcmp( ex->key.mac, ey->key.mac, OFP_ETH_ALEN ) == 0 )
+           && ( ex->key.datapath_id == ey->key.datapath_id );
+}
+
+
+int
+main( int argc, char *argv[] ) {
+  init_trema( &argc, &argv );
+
+  hash_table *forwarding_db = create_hash( compare_forwarding_entry, hash_forwarding_entry );
+  add_periodic_event_callback( AGING_INTERVAL, update_forwarding_db, forwarding_db );
+  set_packet_in_handler( handle_packet_in, forwarding_db );
+
+  start_trema();
+
+  return 0;
+}
+
+
+/*
+ * Local variables:
+ * c-basic-offset: 2
+ * indent-tabs-mode: nil
+ * End:
+ */

data/src/examples/learning_switch/learning_switch.conf

@@ -0,0 +1,18 @@
+vswitch("lsw") {
+  datapath_id "0xabc"
+}
+
+vhost ("host1") {
+  ip "192.168.0.1"
+  netmask "255.255.0.0"
+  mac "00:00:00:01:00:01"
+}
+
+vhost ("host2") {
+  ip "192.168.0.2"
+  netmask "255.255.0.0"
+  mac "00:00:00:01:00:02"
+}
+
+link "lsw", "host1"
+link "lsw", "host2"

data/src/examples/list_switches/README

@@ -0,0 +1,19 @@
+This directory includes an example that demonstrates how you can
+retrieve the list of OpenFlow switches currently connected.
+
+# How to Run (C version)
+
+Run this:
+
+  % ./trema run -c ./src/examples/list_switches/list_switches.conf ./objects/examples/list_switches/list_switches
+
+then you will be able to see the list of switches (datapath ids)
+periodically.
+
+  switches = 0xe0, 0xe1, 0xe2, 0xe3
+
+# How to Run (Ruby version)
+
+  % ./trema run -c ./src/examples/list_switches/list_switches.conf ./src/examples/list_switches/list-switches.rb
+
+Enjoy!

data/src/examples/list_switches/list-switches.rb

@@ -0,0 +1,45 @@
+#
+# Get the list of switches
+#
+# Author: Kazushi SUGYO
+#
+# 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 ListSwitches < Controller
+  periodic_timer_event :send_list_switches_request, 2
+  periodic_timer_event :timeout, 30
+
+
+  def list_switches_reply dpids
+    info "switches = %s" % dpids.collect { | each | sprintf( "0x%x", each ) }.join( ", " )
+    shutdown!
+  end
+
+
+  def timeout
+    error "List switches request timeout."
+    shutdown!
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8
+### indent-tabs-mode: nil
+### End:

data/src/examples/list_switches/list_switches.c

@@ -0,0 +1,81 @@
+/*
+ * Author: Kazushi SUGYO
+ *
+ * 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
+join( char *result, const list_element *switches ) {
+  const char comma[] = ", ";
+  const list_element *element;
+  for ( element = switches; element != NULL; element = element->next ) {
+    char tmp[ 19 ]; // "0x" + 64bits in hex + '\0'
+    snprintf( tmp, sizeof( tmp ), "%#" PRIx64, * ( uint64_t *) element->data );
+    strcat( result, tmp );
+    strcat( result, comma );
+  }
+  result[ strlen( result ) - strlen( comma ) ] = '\0';
+}
+
+
+static void
+handle_list_switches_reply( const list_element *switches, void *user_data ) {
+  UNUSED( user_data );
+
+  unsigned int num_switch = list_length_of( switches );
+
+  char *list = xmalloc( 20 * num_switch + 1 ); // 20 = dpid string (18 chars) + ", "
+  list[ 0 ] = '\0';
+  join( list, switches );
+  info( "switches = %s", list );
+  xfree( list );
+
+  stop_trema();
+}
+
+
+static void
+timeout( void *user_data ) {
+  UNUSED( user_data );
+
+  error( "List switches request timeout." );
+  stop_trema();
+}
+
+
+int
+main( int argc, char *argv[] ) {
+  init_trema( &argc, &argv );
+  add_periodic_event_callback( 30, timeout, NULL );
+
+  add_periodic_event_callback( 2, ( void ( * ) ( void * ) )send_list_switches_request, NULL );
+  set_list_switches_reply_handler( handle_list_switches_reply );
+
+  start_trema();
+}
+
+
+/*
+ * Local variables:
+ * c-basic-offset: 2
+ * indent-tabs-mode: nil
+ * End:
+ */

data/src/examples/list_switches/list_switches.conf

@@ -0,0 +1,15 @@
+vswitch {
+  datapath_id "0xe0"
+}
+
+vswitch {
+  datapath_id "0xe1"
+}
+
+vswitch {
+  datapath_id "0xe2"
+}
+
+vswitch {
+  datapath_id "0xe3"
+}

data/src/examples/match_compare/match-compare.conf

@@ -0,0 +1,30 @@
+vswitch { dpid "0xabc" }
+
+vhost {
+  ip "192.168.0.1"
+  netmask "255.255.0.0"
+  mac "00:00:00:01:00:01"
+}
+
+vhost {
+  ip "192.168.0.2"
+  netmask "255.255.0.0"
+  mac "00:00:00:01:00:02"
+}
+
+vhost {
+  ip "10.0.0.1"
+  netmask "255.0.0.0"
+  mac "00:00:00:01:01:01"
+}
+
+vhost {
+  ip "10.0.0.2"
+  netmask "255.0.0.0"
+  mac "00:00:00:01:01:02"
+}
+
+link "0xabc", "192.168.0.1"
+link "0xabc", "192.168.0.2"
+link "0xabc", "10.0.0.1"
+link "0xabc", "10.0.0.2"