trema 0.1.3

data/src/lib/trema.h

@@ -0,0 +1,79 @@
+/*
+ * Trema common functions.
+ *
+ * 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 TREMA_H
+#define TREMA_H
+
+
+#include "bool.h"
+#include "buffer.h"
+#include "byteorder.h"
+#include "checks.h"
+#include "doubly_linked_list.h"
+#include "etherip.h"
+#include "event_handler.h"
+#include "hash_table.h"
+#include "linked_list.h"
+#include "log.h"
+#include "match.h"
+#include "match_table.h"
+#include "message_queue.h"
+#include "messenger.h"
+#include "openflow_application_interface.h"
+#include "openflow_message.h"
+#include "packet_info.h"
+#include "packetin_filter_interface.h"
+#include "persistent_storage.h"
+#include "stat.h"
+#include "timer.h"
+#include "utility.h"
+#include "wrapper.h"
+
+
+static const char DEFAULT_DUMP_SERVICE_NAME[] = "dump_service";
+
+
+void init_trema( int *argc, char ***argv );
+void start_trema( void );
+void start_trema_up();
+void start_trema_down();
+void stop_trema( void );
+void flush( void );
+const char *get_trema_home( void );
+const char *get_trema_tmp( void );
+void set_trema_name( const char *name );
+const char *get_trema_name( void );
+const char *get_executable_name( void );
+pid_t get_trema_process_from_name( const char *name );
+bool terminate_trema_process( pid_t pid );
+__attribute__( ( weak ) ) void usage( void );
+
+
+#endif // TREMA_H
+
+
+/*
+ * Local variables:
+ * c-basic-offset: 2
+ * indent-tabs-mode: nil
+ * End:
+ */

data/src/lib/trema_private.c

@@ -0,0 +1,177 @@
+/*
+ * 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 <assert.h>
+#include <errno.h>
+#include <limits.h>
+#include <stdint.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include "bool.h"
+#include "log.h"
+#include "trema_private.h"
+#include "trema_wrapper.h"
+#include "wrapper.h"
+
+
+#ifdef UNIT_TESTING
+
+#define static
+
+#endif // UNIT_TESTING
+
+
+static const char TREMA_HOME[] = "TREMA_HOME";
+static const char TREMA_TMP[] = "TREMA_TMP";
+static char *trema_home = NULL;
+static char *trema_tmp = NULL;
+
+
+static bool
+expand( const char *path, char *absolute_path ) {
+  assert( path != NULL );
+  assert( absolute_path != NULL );
+
+  char buf[ 256 ];
+  char *result = realpath( path, absolute_path );
+  if ( result == NULL ) {
+    trema_fprintf( stderr, "Could not get the absolute path of %s: %s.\n", path, strerror_r( errno, buf, sizeof( buf ) ) );
+    return false;
+  }
+
+  return true;
+}
+
+
+/**
+ * Sets trema home directory for your trema session.
+ */
+void
+set_trema_home( void ) {
+  if ( getenv( TREMA_HOME ) == NULL ) {
+    setenv( TREMA_HOME, "/", 1 );
+    trema_home = xstrdup( "/" );
+  }
+  else {
+    char absolute_path[ PATH_MAX ];
+    if ( !expand( getenv( TREMA_HOME ), absolute_path ) ) {
+      trema_fprintf( stderr, "Falling back TREMA_HOME to \"/\".\n" );
+      strncpy( absolute_path, "/", 2 );
+    }
+    setenv( TREMA_HOME, absolute_path, 1 );
+    trema_home = xstrdup( absolute_path );
+  }
+}
+
+
+/**
+ * Returns trema home directory used in your trema session.
+ */
+const char *
+get_trema_home( void ) {
+  if ( trema_home == NULL ) {
+    set_trema_home();
+  }
+  return trema_home;
+}
+
+
+/**
+ * Unsets trema home directory used in your trema session.
+ */
+void unset_trema_home( void ) {
+  if ( trema_home != NULL ) {
+    xfree( trema_home );
+    trema_home = NULL;
+  }
+}
+
+
+/**
+ * Sets temporary directory for your Trema session.
+ */
+void
+set_trema_tmp( void ) {
+  char path[ PATH_MAX ];
+
+  if ( getenv( TREMA_TMP ) == NULL ) {
+    const char *trema_home = get_trema_home();
+    if ( trema_home[ strlen( trema_home ) - 1 ] == '/' ) {
+      snprintf( path, PATH_MAX, "%stmp", trema_home );
+    }
+    else {
+      snprintf( path, PATH_MAX, "%s/tmp", trema_home );
+    }
+    path[ PATH_MAX - 1 ] = '\0';
+  }
+  else {
+    if ( !expand( getenv( TREMA_TMP ), path ) ) {
+      trema_fprintf( stderr, "Falling back TREMA_TMP to \"/tmp\".\n" );
+      strncpy( path, "/tmp", 5 );
+    }
+  }
+
+  trema_tmp = xstrdup( path );
+  setenv( TREMA_TMP, trema_tmp, 1 );
+}
+
+
+/**
+ * Returns temporary directory used in your Trema session.
+ */
+const char *
+get_trema_tmp( void ) {
+  if ( trema_tmp == NULL ) {
+    set_trema_tmp();
+  }
+  return trema_tmp;
+}
+
+
+/**
+ * Unsets temporary directory used in your Trema session.
+ */
+void unset_trema_tmp( void ) {
+  if ( trema_tmp != NULL ) {
+    xfree( trema_tmp );
+    trema_tmp = NULL;
+  }
+}
+
+
+const char *
+_get_trema_home( void ) {
+  return trema_home;
+}
+
+
+const char *
+_get_trema_tmp( void ) {
+  return trema_tmp;
+}
+
+
+/*
+ * Local variables:
+ * c-basic-offset: 2
+ * indent-tabs-mode: nil
+ * End:
+ */

data/src/lib/trema_private.h

@@ -0,0 +1,60 @@
+/*
+ * Private functions that are only called from [trema]/src/lib or [trema]/unittests.
+ *
+ * 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 TREMA_PRIVATE_H
+#define TREMA_PRIVATE_H
+
+
+#include <sqlite3.h>
+#include "bool.h"
+
+
+void set_trema_home( void );
+const char *get_trema_home( void );
+void unset_trema_home( void );
+
+void set_trema_tmp( void );
+const char *get_trema_tmp( void );
+void unset_trema_tmp( void );
+
+
+const char *_get_trema_home( void );
+const char *_get_trema_tmp( void );
+
+const char *_get_db_file( void );
+const sqlite3 *_get_db_handle( void );
+
+bool _get_backend_initialized( void );
+
+size_t _get_max_key_length( void );
+size_t _get_max_value_length( void );
+
+
+#endif // TREMA_PRIVATE_H
+
+
+/*
+ * Local variables:
+ * c-basic-offset: 2
+ * indent-tabs-mode: nil
+ * End:
+ */

data/src/lib/trema_wrapper.c

@@ -0,0 +1,56 @@
+/*
+ * 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 <sqlite3.h>
+#include <stdarg.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <sys/types.h>
+#include <unistd.h>
+
+
+int ( *trema_fprintf )( FILE *stream, const char *format, ... ) = fprintf;
+int ( *trema_vprintf )( const char *format, va_list ap ) = vprintf;
+int ( *trema_vasprintf )( char **strp, const char *fmt, va_list ap ) = vasprintf;
+
+void * ( *trema_malloc )( size_t size ) = malloc;
+void * ( *trema_calloc )( size_t nmemb, size_t size ) = calloc;
+void ( *trema_free )( void *ptr ) = free;
+
+void ( *trema_abort )( void ) = abort;
+
+int ( *trema_unlink )( const char *pathname ) = unlink;
+
+pid_t ( *trema_getpid )( void ) = getpid;
+
+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_changes )( sqlite3 * ) = sqlite3_changes;
+void ( *trema_sqlite3_free )( void * ) = sqlite3_free;
+const char * ( *trema_sqlite3_errmsg )( sqlite3 * ) = sqlite3_errmsg;
+
+
+/*
+ * Local variables:
+ * c-basic-offset: 2
+ * indent-tabs-mode: nil
+ * End:
+ */

data/src/lib/trema_wrapper.h

@@ -0,0 +1,64 @@
+/*
+ * Wraps *printf family.
+ *
+ * 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 TREMA_WRAPPER_H
+#define TREMA_WRAPPER_H
+
+
+#include <sqlite3.h>
+#include <stdarg.h>
+#include <stdio.h>
+#include <sys/types.h>
+#include <unistd.h>
+
+
+extern int ( *trema_fprintf )( FILE *stream, const char *format, ... );
+extern int ( *trema_vprintf )( const char *format, va_list ap );
+extern int ( *trema_vasprintf )( char **strp, const char *fmt, va_list ap );
+
+extern void * ( *trema_malloc )( size_t size );
+extern void * ( *trema_calloc )( size_t nmemb, size_t size );
+extern void ( *trema_free )( void *ptr );
+
+extern void ( *trema_abort )( void );
+
+extern int ( *trema_unlink ) ( const char *pathname );
+
+extern pid_t ( *trema_getpid )( void );
+
+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
+
+
+/*
+ * Local variables:
+ * c-basic-offset: 2
+ * indent-tabs-mode: nil
+ * End:
+ */

data/src/lib/udp.h

@@ -0,0 +1,43 @@
+/*
+ * UDP header definitions
+ *
+ * Author: Kazuya Suzuki
+ *
+ * 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 UDP_H
+#define UDP_H
+
+
+typedef struct udp_header {
+  uint16_t src_port;
+  uint16_t dst_port;
+  uint16_t len;
+  uint16_t csum;
+} udp_header_t;
+
+
+#endif // UDP_H
+
+
+/*
+ * Local variables:
+ * c-basic-offset: 2
+ * indent-tabs-mode: nil
+ * End:
+ */