trema 0.1.3

data/src/switch_manager/switch_manager.h

@@ -0,0 +1,63 @@
+/*
+ * OpenFlow Switch Listener
+ *
+ * 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.
+ */
+
+
+#ifndef SWITCH_LISTENER_H
+#define SWITCH_LISTENER_H
+
+
+#include <sys/types.h>
+
+
+static const char SWITCH_MANAGER_NAME_OPTION[] = "--name=";
+static const uint SWITCH_MANAGER_NAME_OPTION_STR_LEN = sizeof( SWITCH_MANAGER_NAME_OPTION );
+static const char SWITCH_MANAGER_SOCKET_OPTION[] = "--socket=";
+static const uint SWITCH_MANAGER_SOCKET_OPTION_STR_LEN = sizeof( SWITCH_MANAGER_SOCKET_OPTION );
+static const char SWITCH_MANAGER_DAEMONIZE_OPTION[] = "--daemonize";
+static const uint SWITCH_MANAGER_SOCKET_STR_LEN = sizeof( "2147483647" );
+static const char SWITCH_MANAGER_COMMAND_PREFIX[] = "switch.";
+static const uint SWITCH_MANAGER_COMMAND_PREFIX_STR_LEN = sizeof( SWITCH_MANAGER_COMMAND_PREFIX );
+static const char SWITCH_MANAGER_PREFIX[] = "switch.";
+static const uint SWITCH_MANAGER_PREFIX_STR_LEN = sizeof( SWITCH_MANAGER_PREFIX );
+static const uint SWITCH_MANAGER_ADDR_STR_LEN = sizeof( "255.255.255.255:65535" );
+
+static const char SWITCH_MANAGER_PATH[] = "objects/switch_manager/switch";
+static const char SWITCH_MANAGER_STATE_PREFIX[] = "state_notify::";
+
+
+struct listener_info {
+  const char *switch_daemon;
+  int switch_daemon_argc;
+  char **switch_daemon_argv;
+  uint16_t listen_port;
+  int listen_fd;
+};
+
+
+#endif // SWITCH_LISTENER_H
+
+
+/*
+ * Local variables:
+ * c-basic-offset: 2
+ * indent-tabs-mode: nil
+ * End:
+ */

data/src/switch_manager/switchinfo.h

@@ -0,0 +1,72 @@
+/*
+ * OpenFlow Switch Manager
+ *
+ * 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 SWITCHINFO_H
+#define SWITCHINFO_H
+
+
+#include "message_queue.h"
+
+
+#define SWITCH_STATE_CONNECTED           0
+#define SWITCH_STATE_WAIT_HELLO          1
+#define SWITCH_STATE_WAIT_FEATURES_REPLY 2
+#define SWITCH_STATE_COMPLETED           3
+#define SWITCH_STATE_DISCONNECTED        4
+
+
+struct switch_info {
+  list_element *vendor_service_name_list;     // vender manager service
+  list_element *packetin_service_name_list;   // packetin manager service
+  list_element *portstatus_service_name_list; // portstatus manager service
+  list_element *state_service_name_list;      // switch state manager service
+
+  char *dpid_service_name;      // service name of messenger
+  struct notify_info *notify_info;
+
+  int secure_channel_fd;        // socket file descriptor of secure channel
+  bool flow_cleanup;
+
+  int state;                    // state of switch secure channel
+  uint64_t datapath_id;
+
+  uint16_t config_flags;        // OFPC_* flags
+  uint16_t miss_send_len;       /* Max bytes of new flow that datapath should
+                                   send to the controller. */
+
+  buffer *fragment_buf;         /* openflow message fragmentation buffer of
+                                   secure channel receiver */
+
+  message_queue *send_queue;
+  message_queue *recv_queue;
+
+  bool running_timer;
+};
+
+
+#endif // SWITCHINFO_H
+
+
+/*
+ * Local variables:
+ * c-basic-offset: 2
+ * indent-tabs-mode: nil
+ * End:
+ */

data/src/switch_manager/xid_table.c

@@ -0,0 +1,184 @@
+/*
+ * 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 <assert.h>
+#include <openflow.h>
+#include <string.h>
+#include "trema.h"
+#include "xid_table.h"
+
+
+static uint32_t transaction_id = 0U;
+
+#define XID_MAX_ENTRIES 4096
+
+typedef struct xid_table {
+  xid_entry_t *entries[ XID_MAX_ENTRIES ];
+  hash_table *hash;
+  int next_index;
+} xid_table_t;
+
+static xid_table_t xid_table;
+
+
+uint32_t
+generate_xid( void ) {
+  uint32_t initial_value = ( transaction_id != UINT32_MAX ) ? ++transaction_id : 0;
+
+  while ( lookup_xid_entry( transaction_id ) != NULL ) {
+    if ( transaction_id != UINT32_MAX ) {
+      transaction_id++;
+    }
+    else {
+      transaction_id = 0;
+    }
+    if ( initial_value == transaction_id ) {
+      error( "Failed to generate transaction id value." );
+      transaction_id = 0;
+      break;
+    }
+  }
+
+  return transaction_id;
+}
+
+
+static xid_entry_t *
+allocate_xid_entry( uint32_t original_xid, char *service_name, int index ) {
+  xid_entry_t *new_entry;
+
+  new_entry = xmalloc( sizeof ( xid_entry_t ) );
+  new_entry->xid = generate_xid();
+  new_entry->original_xid = original_xid;
+  new_entry->service_name = xstrdup( service_name );
+  new_entry->index = index;
+
+  return new_entry;
+}
+
+
+static void
+free_xid_entry( xid_entry_t *free_entry ) {
+  xfree( free_entry->service_name );
+  xfree( free_entry );
+}
+
+
+void
+init_xid_table( void ) {
+  memset( &xid_table, 0, sizeof( xid_table_t ) );
+  xid_table.hash = create_hash( compare_uint32, hash_uint32 );
+  xid_table.next_index = 0;
+}
+
+
+void
+finalize_xid_table( void ) {
+  for( int i = 0; i < XID_MAX_ENTRIES; i++ ) {
+    if ( xid_table.entries[ i ] != NULL ) {
+      free_xid_entry( xid_table.entries[ i ] );
+      xid_table.entries[ i ] = NULL;
+    }
+  }
+  delete_hash( xid_table.hash );
+  xid_table.hash = NULL;
+  xid_table.next_index = 0;
+}
+
+
+uint32_t
+insert_xid_entry( uint32_t original_xid, char *service_name ) {
+  xid_entry_t *new_entry;
+
+  debug( "Inserting xid entry ( original_xid = %#lx, service_name = %s ).",
+         original_xid, service_name );
+
+  if ( xid_table.next_index >= XID_MAX_ENTRIES ) {
+    xid_table.next_index = 0;
+  }
+
+  if ( xid_table.entries[ xid_table.next_index ] != NULL ) {
+    delete_xid_entry( xid_table.entries[ xid_table.next_index ] );
+  }
+
+  new_entry = allocate_xid_entry( original_xid, service_name, xid_table.next_index );
+  xid_entry_t *old = insert_hash_entry( xid_table.hash, &new_entry->xid, new_entry );
+  if ( old != NULL ) {
+    xid_table.entries[ old->index ] = NULL;
+    free_xid_entry( old );
+  }
+  xid_table.entries[ xid_table.next_index ] = new_entry;
+  xid_table.next_index++;
+
+  return new_entry->xid;
+}
+
+
+void
+delete_xid_entry( xid_entry_t *delete_entry ) {
+  debug( "Deleting xid entry ( xid = %#lx, original_xid = %#lx, service_name = %s, index = %d ).",
+         delete_entry->xid, delete_entry->original_xid, delete_entry->service_name, delete_entry->index );
+
+  xid_entry_t *deleted = delete_hash_entry( xid_table.hash, &delete_entry->xid );
+
+  if ( deleted == NULL ) {
+    error( "Failed to delete xid entry ( xid = %#lx ).", delete_entry->xid );
+    free_xid_entry( ( xid_entry_t * ) delete_entry );
+    return;
+  }
+
+  xid_table.entries[ deleted->index ] = NULL;
+  free_xid_entry( deleted );
+}
+
+
+xid_entry_t *
+lookup_xid_entry( uint32_t xid ) {
+  return lookup_hash_entry( xid_table.hash, &xid );
+}
+
+
+static void
+dump_xid_entry( xid_entry_t *entry ) {
+  info( "xid = %#lx, original_xid = %#lx, service_name = %s, index = %d",
+        entry->xid, entry->original_xid, entry->service_name, entry->index );
+}
+
+
+void
+dump_xid_table( void ) {
+  hash_iterator iter;
+  hash_entry *e;
+
+  info( "#### XID TABLE ####" );
+  init_hash_iterator( xid_table.hash, &iter );
+  while ( ( e = iterate_hash_next( &iter ) ) != NULL ) {
+    dump_xid_entry( e->value );
+  }
+  info( "#### END ####" );
+}
+
+
+/*
+ * Local variables:
+ * c-basic-offset: 2
+ * indent-tabs-mode: nil
+ * End:
+ */

data/src/switch_manager/xid_table.h

@@ -0,0 +1,56 @@
+/*
+ * OpenFlow Switch Manager
+ *
+ * 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.
+ */
+
+
+#ifndef XID_TABLE_H
+#define XID_TABLE_H
+
+
+#include "trema.h"
+
+
+typedef struct xid_entry {
+  uint32_t xid;
+  uint32_t original_xid;
+  char *service_name;
+  int index;
+} xid_entry_t;
+
+
+uint32_t generate_xid( void );
+void init_xid_table( void );
+void finalize_xid_table( void );
+uint32_t insert_xid_entry( uint32_t original_xid, char *service_name );
+void delete_xid_entry( xid_entry_t *entry );
+xid_entry_t *lookup_xid_entry( uint32_t xid );
+void dump_xid_table( void );
+
+
+#endif // XID_TABLE_H
+
+
+/*
+ * Local variables:
+ * c-basic-offset: 2
+ * indent-tabs-mode: nil
+ * End:
+ */
+

data/src/tremashark/README

@@ -0,0 +1,78 @@
+README for tremashark
+*********************
+
+  Copyright (C) 2008-2012 NEC Corporation
+
+  Copying and distribution of this file, with or without modification,
+  are permitted in any medium without royalty provided the copyright
+  notice and this notice are preserved. This file is offered as-is,
+  without warranty of any kind.
+
+What is tremashark?
+===================
+
+"tremashark" provides a wireshark (http://www.wireshark.org/) plugin and a
+bridge between the Trema world and wireshark to display various events on
+wireshark. You can monitor any IPC events among Trema modules, packets on
+network interfaces/links, or log messages in realtime. It should be useful
+for learning the Trema world and debugging your OpenFlow controller
+applications.
+
+
+How to build and install?
+=========================
+
+Pre-requirements
+----------------
+
+You need to download the source code of wireshark before you start to build
+tremashark. We have tested with wireshark 1.4.4. Note that the package
+"wireshark-dev" included in Ubuntu or Debian will not work for building the
+wireshark plugin. You can get the source code from the following site:
+
+  http://www.wireshark.org/download.html
+
+Also, you may need to install several software packages.
+
+  $ sudo apt-get install wireshark flex bison libgtkmm-2.4-dev
+
+Build and install
+-----------------
+
+Before building tremashark, you should compile Trema (see INSTALL) first.
+Then build the plugin as follows:
+
+  $ cd [trema]/src/tremashark/plugin
+  $ tar xvf /somewhere/wireshark-X.Y.Z.tar.bz2
+  $ ln -s wireshark-X.Y.Z wireshark
+  $ cd wireshark
+  $ ./configure
+  $ cd ../packet-trema
+  $ make
+  $ mkdir -p ~/.wireshark/plugins
+  $ cp packet-trema.so ~/.wireshark/plugins
+  $ cp ../user_dlts ~/.wireshark/
+
+
+How to run?
+===========
+
+1. Add `use_tremashark' directive in your Trema configuration. e.g.,
+
+  use_tremashark
+
+  vswitch {
+    datapath_id "0x1"
+  }
+  ...
+
+2. Send SIGUSR2 to processes to be monitored by tremashark. e.g.,
+
+  $ sudo kill -USR2 `cat tmp/learning_switch.pid`
+  $ sudo kill -USR2 `cat tmp/switch.1.pid`
+
+Known issue
+===========
+
+- Wireshark plugin would not correctly reassemble messages when plural
+  fragments are on a single packet.