trema 0.2.5 → 0.2.6

data/src/lib/stat.h

@@ -21,15 +21,24 @@
 
 
 #ifndef STAT_H
+#define STAT_H
 
 
 #define STAT_KEY_LENGTH 256
 
 
+typedef struct {
+  char key[ STAT_KEY_LENGTH ];
+  uint64_t value;
+} stat_entry;
+
+
 bool init_stat( void );
 bool finalize_stat( void );
 bool add_stat_entry( const char *key );
 void increment_stat( const char *key );
+void reset_stats( void );
+void foreach_stat( void function( const char *key, const uint64_t value, void *user_data ), void *user_data );
 void dump_stats();
 
 

data/src/lib/timer.c

@@ -20,6 +20,7 @@
 
 #include <assert.h>
 #include <errno.h>
+#include <inttypes.h>
 #include <limits.h>
 #include "doubly_linked_list.h"
 #include "log.h"
@@ -143,9 +144,9 @@ on_timer( timer_callback_info *callback, struct timespec *now ) {
   assert( callback != NULL );
   assert( callback->function != NULL );
 
-  debug( "Executing a timer event ( function = %p, expires_at = %u.%09u, interval = %u.%09u, user_data = %p ).",
-         callback->function, callback->expires_at.tv_sec, callback->expires_at.tv_nsec,
-         callback->interval.tv_sec, callback->interval.tv_nsec, callback->user_data );
+  debug( "Executing a timer event ( function = %p, expires_at = %" PRIu64 ".%09lu, interval = %" PRIu64 ".%09lu, user_data = %p ).",
+         callback->function, ( int64_t ) callback->expires_at.tv_sec, callback->expires_at.tv_nsec,
+         ( int64_t ) callback->interval.tv_sec, callback->interval.tv_nsec, callback->user_data );
 
   if ( VALID_TIMESPEC( &callback->expires_at ) ) {
     callback->function( callback->user_data );
@@ -161,7 +162,7 @@ on_timer( timer_callback_info *callback, struct timespec *now ) {
       callback->expires_at.tv_nsec = 0;
       callback->function = NULL;
     }
-    debug( "Set expires_at value to %u.%09u.", callback->expires_at.tv_sec, callback->expires_at.tv_nsec );
+    debug( "Set expires_at value to %" PRIu64 ".%09lu.", ( int64_t ) callback->expires_at.tv_sec, callback->expires_at.tv_nsec );
   }
   else {
     error( "Invalid expires_at value." );
@@ -245,9 +246,9 @@ _add_timer_event_callback( struct itimerspec *interval, timer_callback callback,
   assert( interval != NULL );
   assert( callback != NULL );
 
-  debug( "Adding a timer event callback ( interval = %u.%09u, initial expiration = %u.%09u, callback = %p, user_data = %p ).",
-         interval->it_interval.tv_sec, interval->it_interval.tv_nsec,
-         interval->it_value.tv_sec, interval->it_value.tv_nsec, callback, user_data );
+  debug( "Adding a timer event callback ( interval = %" PRIu64 ".%09lu, initial expiration = %" PRIu64 ".%09lu, callback = %p, user_data = %p ).",
+         ( int64_t ) interval->it_interval.tv_sec, interval->it_interval.tv_nsec,
+         ( int64_t ) interval->it_value.tv_sec, interval->it_value.tv_nsec, callback, user_data );
 
   timer_callback_info *cb;
   struct timespec now;
@@ -277,7 +278,7 @@ _add_timer_event_callback( struct itimerspec *interval, timer_callback callback,
     return false;
   }
 
-  debug( "Set an initial expiration time to %u.%09u.", now.tv_sec, now.tv_nsec );
+  debug( "Set an initial expiration time to %" PRIu64 ".%09lu.", ( int64_t ) now.tv_sec, now.tv_nsec );
 
   assert( timer_callbacks != NULL );
   insert_timer_callback( cb );
@@ -291,8 +292,8 @@ bool
 _add_periodic_event_callback( const time_t seconds, timer_callback callback, void *user_data ) {
   assert( callback != NULL );
 
-  debug( "Adding a periodic event callback ( interval = %u, callback = %p, user_data = %p ).",
-         seconds, callback, user_data );
+  debug( "Adding a periodic event callback ( interval = %" PRIu64 ", callback = %p, user_data = %p ).",
+         ( const int64_t ) seconds, callback, user_data );
 
   struct itimerspec interval;
 

data/src/lib/trema.c

@@ -35,6 +35,7 @@
 #include "daemon.h"
 #include "doubly_linked_list.h"
 #include "log.h"
+#include "management_interface.h"
 #include "messenger.h"
 #include "openflow_application_interface.h"
 #include "packetin_filter_interface.h"
@@ -200,7 +201,7 @@ bool mock_finalize_openflow_application_interface( void );
 #undef printf
 #endif
 #define printf mock_printf
-int mock_printf(const char *format, ...);
+int mock_printf( const char *format, ...);
 
 typedef struct stat _stat;
 #ifdef stat
@@ -243,7 +244,7 @@ bool mock_finalize_timer();
 #undef set_external_callback
 #endif
 #define set_external_callback mock_set_external_callback
-bool mock_set_external_callback( void ( *callback ) ( void ) );
+bool mock_set_external_callback( void ( *callback )( void ) );
 
 #ifdef dump_stats
 #undef dump_stats
@@ -257,6 +258,18 @@ void mock_dump_stats();
 #define finalize_packetin_filter_interface mock_finalize_packetin_filter_interface
 bool mock_finalize_packetin_filter_interface();
 
+#ifdef init_management_interface
+#undef init_management_interface
+#endif
+#define init_management_interface mock_init_management_interface
+bool mock_init_management_interface();
+
+#ifdef finalize_management_interface
+#undef finalize_management_interface
+#endif
+#define finalize_management_interface mock_finalize_management_interface
+bool mock_finalize_management_interface();
+
 #define static
 
 #endif // UNIT_TESTING
@@ -284,10 +297,11 @@ static struct option long_options[] = {
   { "daemonize", 0, NULL, 'd' },
   { "logging_level", 1, NULL, 'l' },
   { "syslog", 0, NULL, 'g' },
+  { "logging_facility", 1, NULL, 'f' },
   { "help", 0, NULL, 'h' },
   { NULL, 0, NULL, 0 },
 };
-static char short_options[] = "n:dl:gh";
+static char short_options[] = "n:dl:gf:h";
 
 
 /**
@@ -301,11 +315,12 @@ usage() {
   printf(
     "Usage: %s [OPTION]...\n"
     "\n"
-    "  -n, --name=SERVICE_NAME     service name\n"
-    "  -d, --daemonize             run in the background\n"
-    "  -l, --logging_level=LEVEL   set logging level\n"
-    "  -g, --syslog                output log messages to syslog\n"
-    "  -h, --help                  display this help and exit\n",
+    "  -n, --name=SERVICE_NAME         service name\n"
+    "  -d, --daemonize                 run in the background\n"
+    "  -l, --logging_level=LEVEL       set logging level\n"
+    "  -g, --syslog                    output log messages to syslog\n"
+    "  -f, --logging_facility=FACILITY set syslog facility\n"
+    "  -h, --help                      display this help and exit\n",
     executable_name
   );
 }
@@ -367,6 +382,7 @@ finalize_trema() {
   debug( "Terminating %s...", get_trema_name() );
 
   maybe_finalize_openflow_application_interface();
+  finalize_management_interface();
   finalize_packetin_filter_interface();
   finalize_messenger();
   finalize_stat();
@@ -443,6 +459,9 @@ parse_argv( int *argc, char ***argv ) {
       case 'g':
         log_output_type = LOGGING_TYPE_SYSLOG;
         break;
+      case 'f':
+        set_syslog_facility( optarg );
+        break;
       case 'h':
         usage();
         xfree( trema_name );
@@ -607,6 +626,7 @@ init_trema( int *argc, char ***argv ) {
   init_messenger( get_trema_sock() );
   init_stat();
   init_timer();
+  init_management_interface();
 
   initialized = true;
 
@@ -631,7 +651,7 @@ start_trema_up() {
 
   die_unless_initialized();
 
-  debug( "Starting %s ... (TREMA_HOME = %s)", get_trema_name(), get_trema_home() );
+  debug( "Starting %s ... ( TREMA_HOME = %s )", get_trema_name(), get_trema_home() );
 
   maybe_daemonize();
   write_pid( get_trema_pid(), get_trema_name() );
@@ -735,6 +755,15 @@ terminate_trema_process( pid_t pid ) {
 }
 
 
+void
+_free_trema_name() {
+  if ( trema_name != NULL ) {
+    xfree( trema_name );
+    trema_name = NULL;
+  }
+}
+
+
 /*
  * Local variables:
  * c-basic-offset: 2

data/src/lib/trema.h

@@ -34,6 +34,7 @@
 #include "hash_table.h"
 #include "linked_list.h"
 #include "log.h"
+#include "management_service_interface.h"
 #include "match.h"
 #include "match_table.h"
 #include "message_queue.h"

data/src/lib/trema_private.h

@@ -26,6 +26,7 @@
 
 #include <sqlite3.h>
 #include "bool.h"
+#include "management_service_interface.h"
 
 
 void set_trema_home( void );
@@ -39,6 +40,7 @@ void unset_trema_tmp( void );
 
 const char *_get_trema_home( void );
 const char *_get_trema_tmp( void );
+void _free_trema_name( void );
 
 const char *_get_db_file( void );
 const sqlite3 *_get_db_handle( void );
@@ -48,6 +50,10 @@ bool _get_backend_initialized( void );
 size_t _get_max_key_length( void );
 size_t _get_max_value_length( void );
 
+bool *_get_management_interface_initialized( void );
+
+void _set_management_application_request_handler( management_application_request_handler callback, void *user_data );
+
 
 #endif // TREMA_PRIVATE_H
 

data/src/lib/trema_wrapper.c

@@ -41,13 +41,13 @@ int ( *trema_unlink )( const char *pathname ) = unlink;
 
 pid_t ( *trema_getpid )( void ) = getpid;
 
-void ( *trema_openlog ) ( const char *ident, int option, int facility ) = openlog;
-void ( *trema_closelog ) ( void ) = closelog;
-void ( *trema_vsyslog ) ( int priority, const char *format, va_list ap ) = vsyslog;
+void ( *trema_openlog )( const char *ident, int option, int facility ) = openlog;
+void ( *trema_closelog )( void ) = closelog;
+void ( *trema_vsyslog )( int priority, const char *format, va_list ap ) = vsyslog;
 
 int ( *trema_sqlite3_open )( const char *filename, sqlite3 **ppDb ) = sqlite3_open;
 int ( *trema_sqlite3_close )( sqlite3 * ) = sqlite3_close;
-int ( *trema_sqlite3_exec )( sqlite3 *, const char *sql, int ( *callback ) ( void *, int, char **, char ** ), void *, char **errmsg ) = sqlite3_exec;
+int ( *trema_sqlite3_exec )( sqlite3 *, const char *sql, int ( *callback )( void *, int, char **, char ** ), void *, char **errmsg ) = sqlite3_exec;
 int ( *trema_sqlite3_changes )( sqlite3 * ) = sqlite3_changes;
 void ( *trema_sqlite3_free )( void * ) = sqlite3_free;
 const char * ( *trema_sqlite3_errmsg )( sqlite3 * ) = sqlite3_errmsg;

data/src/lib/trema_wrapper.h

@@ -41,20 +41,20 @@ extern void ( *trema_free )( void *ptr );
 
 extern void ( *trema_abort )( void );
 
-extern int ( *trema_unlink ) ( const char *pathname );
+extern int ( *trema_unlink )( const char *pathname );
 
 extern pid_t ( *trema_getpid )( void );
 
-extern void ( *trema_openlog ) ( const char *ident, int option, int facility );
-extern void ( *trema_closelog ) ( void );
-extern void ( *trema_vsyslog ) ( int priority, const char *format, va_list ap );
+extern void ( *trema_openlog )( const char *ident, int option, int facility );
+extern void ( *trema_closelog )( void );
+extern void ( *trema_vsyslog )( int priority, const char *format, va_list ap );
 
-extern int ( *trema_sqlite3_open) ( const char *filename, sqlite3 **ppDb );
-extern int ( *trema_sqlite3_close ) ( sqlite3 * );
-extern int ( *trema_sqlite3_exec ) ( sqlite3 *, const char *sql, int ( *callback ) ( void *, int, char **, char ** ), void *, char **errmsg );
-extern int ( *trema_sqlite3_changes ) ( sqlite3 * );
-extern void ( *trema_sqlite3_free ) ( void * );
-extern const char * ( *trema_sqlite3_errmsg ) ( sqlite3 * );
+extern int ( *trema_sqlite3_open )( const char *filename, sqlite3 **ppDb );
+extern int ( *trema_sqlite3_close )( sqlite3 * );
+extern int ( *trema_sqlite3_exec )( sqlite3 *, const char *sql, int ( *callback )( void *, int, char **, char ** ), void *, char **errmsg );
+extern int ( *trema_sqlite3_changes )( sqlite3 * );
+extern void ( *trema_sqlite3_free )( void * );
+extern const char * ( *trema_sqlite3_errmsg )( sqlite3 * );
 
 
 #endif // TREMA_WRAPPER_H

data/src/lib/utility.c

@@ -45,7 +45,7 @@ _die( const char *format, ... ) {
   vsnprintf( err, sizeof( err ), format, args );
   va_end( args );
 
-  critical( err );
+  critical( "%s", err );
   trema_abort();
 }
 void ( *die )( const char *format, ... ) = _die;
@@ -176,7 +176,7 @@ wildcards_to_string( uint32_t wildcards, char *str, size_t size ) {
   uint32_t nw_src_mask = ( wildcards & OFPFW_NW_SRC_MASK ) >> OFPFW_NW_SRC_SHIFT;
   uint32_t nw_dst_mask = ( wildcards & OFPFW_NW_DST_MASK ) >> OFPFW_NW_DST_SHIFT;
   uint32_t mask = OFPFW_ALL & ~OFPFW_NW_SRC_MASK & ~OFPFW_NW_DST_MASK;
-  if ( ( wildcards & mask ) == mask && nw_src_mask >=32 && nw_dst_mask >= 32 ) {
+  if ( ( wildcards & mask ) == mask && nw_src_mask >= 32 && nw_dst_mask >= 32 ) {
     ret &= append_string( str, size, "all" );
     return ret;
   }
@@ -195,7 +195,7 @@ wildcards_to_string( uint32_t wildcards, char *str, size_t size ) {
   }
   if ( wildcards & OFPFW_DL_VLAN ) {
     ret &= append_string( str, size, "dl_vlan|" );
-  } 
+  }
   if ( wildcards & OFPFW_DL_VLAN_PCP ) {
     ret &= append_string( str, size, "dl_vlan_pcp|" );
   }
@@ -263,7 +263,7 @@ match_to_string( const struct ofp_match *match, char *str, size_t size ) {
               "wildcards = %#x(%s), in_port = %u, "
               "dl_src = %02x:%02x:%02x:%02x:%02x:%02x, "
               "dl_dst = %02x:%02x:%02x:%02x:%02x:%02x, "
-              "dl_vlan = %u, dl_vlan_pcp = %u, dl_type = %#x, "
+              "dl_vlan = %#x, dl_vlan_pcp = %#x, dl_type = %#x, "
               "nw_tos = %u, nw_proto = %u, nw_src = %s/%u, nw_dst = %s/%u, "
               "tp_src = %u, tp_dst = %u",
               match->wildcards, wildcards_str, match->in_port,
@@ -520,7 +520,7 @@ actions_to_string( const struct ofp_action_header *actions, uint16_t actions_len
     }
     char *p = str + current_str_length;
     const struct ofp_action_header *header = ( const struct ofp_action_header * ) ( ( const char * ) actions + offset );
-    switch( header->type ) {
+    switch ( header->type ) {
       case OFPAT_OUTPUT:
         ret = action_output_to_string( ( const struct ofp_action_output * ) header, p, remaining_str_length );
         break;
@@ -567,7 +567,7 @@ actions_to_string( const struct ofp_action_header *actions, uint16_t actions_len
 
     if ( ret == false ) {
       break;
-    } 
+    }
     offset += header->len;
   }
 

data/src/management/application.c

@@ -0,0 +1,224 @@
+/*
+ * Management command for any application specific managements.
+ *
+ * Author: Yasunobu Chiba
+ *
+ * Copyright (C) 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 <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include "trema.h"
+
+
+static char service_name[ MESSENGER_SERVICE_NAME_LENGTH ];
+static uint32_t application_id = 0;
+static uint8_t *data = NULL;
+static size_t data_length = 0;
+
+
+void
+usage( void ) {
+  printf( "Usage: application SERVICE_NAME APPLICATION_ID [DATA_IN_HEX]\n" );
+}
+
+
+static void
+print_usage_and_exit( void ) {
+  usage();
+  exit( EXIT_FAILURE );
+}
+
+
+static bool
+hex_string_to_data( char *string ) {
+  assert( string != NULL );
+
+  size_t string_length = strlen( string );
+  if ( string_length % 2 ) {
+    return false;
+  }
+
+  data_length = string_length / 2;
+  data = xmalloc( data_length );
+  memset( data, 0, data_length );
+
+  int byte = 0;
+  for ( size_t i = 0; i < string_length; i++ ) {
+    char c = string[ i ];
+    byte <<= 4;
+
+    if ( ( c >= '0' ) && ( c <= '9' ) ) {
+      byte += c - '0';
+    }
+    else if ( ( c >= 'a' ) && ( c <= 'f' ) ) {
+      byte += c - 'a' + 10;
+    }
+    else if ( ( c >= 'A' ) && ( c <= 'F' ) ) {
+      byte += c - 'A' + 10;
+    }
+    else {
+      xfree( data );
+      data = NULL;
+      data_length = 0;
+      return false;
+    }
+
+    if ( i % 2 ) {
+      data[ i / 2 ] = ( uint8_t ) byte;
+      byte = 0;
+    }
+  }
+
+  return true;
+}
+
+
+static void
+parse_arguments( int argc, char **argv ) {
+  assert( argv != NULL );
+
+  if ( argc < 3 || argc > 4 ) {
+    print_usage_and_exit();
+  }
+
+  if ( argv[ 1 ] == NULL || ( argv[ 1 ] != NULL && strlen( argv[ 1 ] ) == 0 ) ) {
+    print_usage_and_exit();
+  }
+
+  if ( argv[ 2 ] == NULL ) {
+    print_usage_and_exit();
+  }
+
+  memset( service_name, '\0', MESSENGER_SERVICE_NAME_LENGTH );
+  snprintf( service_name, MESSENGER_SERVICE_NAME_LENGTH, "%s", get_management_service_name( argv[ 1 ] ) );
+
+  char *endp = NULL;
+  application_id = ( uint32_t ) strtoul( argv[ 2 ], &endp, 0 );
+  if ( *endp != '\0' ) {
+    print_usage_and_exit();
+  }
+
+  if ( argc >= 4 && argv[ 3 ] != NULL ) {
+    hex_string_to_data( argv[ 3 ] );
+    if ( data == NULL ) {
+      print_usage_and_exit();
+    }
+  }
+}
+
+
+static void
+timeout( void *user_data ) {
+  UNUSED( user_data );
+
+  printf( "Timeout.\n" );
+
+  delete_timer_event( timeout, NULL );
+
+  stop_trema();
+}
+
+
+static void
+handle_reply( uint16_t tag, void *data, size_t length, void *user_data ) {
+  UNUSED( user_data );
+
+  assert( tag == MESSENGER_MANAGEMENT_REPLY );
+  assert( data != NULL );
+  assert( length >= offsetof( management_application_reply, data ) );
+
+  management_application_reply *reply = data;
+  assert( ntohs( reply->header.type ) == MANAGEMENT_APPLICATION_REPLY );
+  assert( ntohl( reply->header.length ) == length );
+  uint32_t id = ntohl( reply->application_id );
+
+  if ( reply->header.status == MANAGEMENT_REQUEST_SUCCEEDED ) {
+    printf( "An application specific management command is executed successfully ( application_id = %#x ).\n", id );
+  }
+  else {
+    printf( "Failed to execute an application specific management command ( application_id = %#x ).\n", id );
+  }
+
+  size_t data_length = length - offsetof( management_application_reply, data );
+  if ( data_length > 0 ) {
+    printf( "Data: " );
+    for ( size_t i = 0; i < data_length; i++ ) {
+      printf( "%02x", reply->data[ i ] );
+    }
+    printf( "\n" );
+  }
+
+  stop_trema();
+}
+
+
+static void
+send_application_request() {
+  size_t length = offsetof( management_application_request, data ) + data_length;
+  management_application_request *request = xmalloc( length );
+  memset( request, 0, sizeof( management_application_request ) );
+  request->header.type = htons( MANAGEMENT_APPLICATION_REQUEST );
+  request->header.length = htonl( ( uint32_t ) length );
+  request->application_id = htonl( application_id );
+  if ( data_length > 0 && data != NULL ) {
+    memcpy( request->data, data, data_length );
+    xfree( data );
+  }
+
+  bool ret = send_request_message( service_name, get_trema_name(), MESSENGER_MANAGEMENT_REQUEST,
+                                   request, length, NULL );
+  xfree( request );
+  if ( !ret ) {
+    printf( "Failed to send an application specific management request to %s.\n", service_name );
+    exit( EXIT_FAILURE );
+  }
+}
+
+
+int
+main( int argc, char *argv[] ) {
+  // Initialize the Trema world
+  init_trema( &argc, &argv );
+
+  // Parse arguments
+  parse_arguments( argc, argv );
+
+  // Set a handler to handle application specific management reply
+  add_message_replied_callback( get_trema_name(), handle_reply );
+
+  // Send an application specific management request
+  send_application_request();
+
+  // Set timeout
+  add_periodic_event_callback( 5, timeout, NULL );
+
+  // Main loop
+  start_trema();
+
+  return EXIT_SUCCESS;
+}
+
+
+/*
+ * Local variables:
+ * c-basic-offset: 2
+ * indent-tabs-mode: nil
+ * End:
+ */