src/testbed/gnunet-daemon-latency-logger.c

   1 /*
   2       This file is part of GNUnet
   3       Copyright (C) 2008--2014 Christian Grothoff (and other contributing authors)
   4
   5       GNUnet is free software; you can redistribute it and/or modify
   6       it under the terms of the GNU General Public License as published
   7       by the Free Software Foundation; either version 3, or (at your
   8       option) any later version.
   9
  10       GNUnet is distributed in the hope that it will be useful, but
  11       WITHOUT ANY WARRANTY; without even the implied warranty of
  12       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13       General Public License for more details.
  14
  15       You should have received a copy of the GNU General Public License
  16       along with GNUnet; see the file COPYING.  If not, write to the
  17       Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  18       Boston, MA 02110-1301, USA.
  19 */
  20
  21 /**
  22  * @file testbed/gnunet-daemon-latency-logger.c
  23  * @brief log latency values from neighbour connections into an SQLite database
  24  * @author Sree Harsha Totakura <sreeharsha@totakura.in>
  25  */
  26
  27 #include "platform.h"
  28 #include "gnunet_util_lib.h"
  29 #include "gnunet_ats_service.h"
  30 #include <sqlite3.h>
  31
  32
  33 /**
  34  * Logging shorthand
  35  */
  36 #define LOG(type,...)                           \
  37   GNUNET_log (type, __VA_ARGS__)
  38
  39 /**
  40  * Debug logging shorthand
  41  */
  42 #define DEBUG(...)                              \
  43   LOG (GNUNET_ERROR_TYPE_DEBUG, __VA_ARGS__)
  44
  45 /**
  46  * Log an error message at log-level 'level' that indicates
  47  * a failure of the command 'cmd' on file 'filename'
  48  * with the message given by strerror(errno).
  49  */
  50 #define LOG_SQLITE(db, msg, level, cmd)                                 \
  51   do {                                                                  \
  52     GNUNET_log_from (level, "sqlite", _("`%s' failed at %s:%d with error: %s\n"), \
  53                      cmd, __FILE__,__LINE__, sqlite3_errmsg(db));  \
  54     if (msg != NULL)                                                    \
  55       GNUNET_asprintf(msg, _("`%s' failed at %s:%u with error: %s"), cmd, \
  56                       __FILE__, __LINE__, sqlite3_errmsg(db));     \
  57   } while(0)
  58
  59
  60 /**
  61  * Entry type to be used in the map to store old latency values
  62  */
  63 struct Entry
  64 {
  65   /**
  66    *  The peer's identity
  67    */
  68   struct GNUNET_PeerIdentity id;
  69
  70   /**
  71    * The last known value for latency.
  72    * FIXME: type!
  73    */
  74   unsigned int latency;
  75
  76 };
  77
  78
  79 /**
  80  * Handle to the map used to store old latency values for peers
  81  */
  82 static struct GNUNET_CONTAINER_MultiPeerMap *map;
  83
  84 /**
  85  * The SQLite database handle
  86  */
  87 static struct sqlite3 *db;
  88
  89 /**
  90  * Handle to the ATS performance subsystem
  91  */
  92 struct GNUNET_ATS_PerformanceHandle *ats;
  93
  94 /**
  95  * Prepared statement for inserting values into the database table
  96  */
  97 struct sqlite3_stmt *stmt_insert;
  98
  99 /**
 100  * Shutdown task identifier
 101  */
 102 struct GNUNET_SCHEDULER_Task * shutdown_task;
 103
 104
 105 /**
 106  * @ingroup hashmap
 107  * Iterator over hash map entries.
 108  *
 109  * @param cls closure
 110  * @param key current public key
 111  * @param value value in the hash map
 112  * @return #GNUNET_YES if we should continue to
 113  *         iterate,
 114  *         #GNUNET_NO if not.
 115  */
 116 static int
 117 free_iterator (void *cls,
 118                const struct GNUNET_PeerIdentity *key,
 119                void *value)
 120 {
 121   struct Entry *e = cls;
 122
 123   GNUNET_assert (GNUNET_YES ==
 124                  GNUNET_CONTAINER_multipeermap_remove (map, key, e));
 125   GNUNET_free (e);
 126   return GNUNET_YES;
 127 }
 128
 129
 130 /**
 131  * Shutdown
 132  *
 133  * @param cls NULL
 134  * @param tc task context from scheduler
 135  * @return
 136  */
 137 static void
 138 do_shutdown (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 139 {
 140   shutdown_task = NULL;
 141   GNUNET_ATS_performance_done (ats);
 142   ats = NULL;
 143   if (NULL != stmt_insert)
 144   {
 145     sqlite3_finalize (stmt_insert);
 146     stmt_insert = NULL;
 147   }
 148   GNUNET_break (SQLITE_OK == sqlite3_close (db));
 149   db = NULL;
 150   if (NULL != map)
 151   {
 152     GNUNET_assert (GNUNET_SYSERR !=
 153                    GNUNET_CONTAINER_multipeermap_iterate (map, free_iterator, NULL));
 154     GNUNET_CONTAINER_multipeermap_destroy (map);
 155     map = NULL;
 156   }
 157 }
 158
 159 /**
 160  * Signature of a function that is called with QoS information about an address.
 161  *
 162  * @param cls closure
 163  * @param address the address
 164  * @param address_active #GNUNET_YES if this address is actively used
 165  *        to maintain a connection to a peer;
 166  *        #GNUNET_NO if the address is not actively used;
 167  *        #GNUNET_SYSERR if this address is no longer available for ATS
 168  * @param bandwidth_out assigned outbound bandwidth for the connection
 169  * @param bandwidth_in assigned inbound bandwidth for the connection
 170  * @param prop performance data for the address (as far as known)
 171  */
 172 static void
 173 addr_info_cb (void *cls,
 174               const struct GNUNET_HELLO_Address *address,
 175               int address_active,
 176               struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
 177               struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
 178               const struct GNUNET_ATS_Properties *prop)
 179 {
 180   static const char *query_insert =
 181       "INSERT INTO ats_info("
 182       " id,"
 183       " val,"
 184       " timestamp"
 185       ") VALUES ("
 186       " ?1,"
 187       " ?2,"
 188       " datetime('now')"
 189       ");";
 190   struct Entry *entry;
 191   int latency; /* FIXME: type!? */
 192
 193   if (NULL == address)
 194   {
 195     /* ATS service temporarily disconnected */
 196     return;
 197   }
 198
 199   GNUNET_assert (NULL != db);
 200   if (GNUNET_YES != address_active)
 201     return;
 202   latency = (int) prop->delay.rel_value_us;
 203   entry = NULL;
 204   if (GNUNET_YES == GNUNET_CONTAINER_multipeermap_contains (map,
 205                                                             &address->peer))
 206   {
 207     entry = GNUNET_CONTAINER_multipeermap_get (map, &address->peer);
 208     GNUNET_assert (NULL != entry);
 209     if (latency == entry->latency)
 210       return;
 211   }
 212   if (NULL == stmt_insert)
 213   {
 214     if (SQLITE_OK != sqlite3_prepare_v2 (db, query_insert, -1, &stmt_insert,
 215                                          NULL))
 216     {
 217       LOG_SQLITE (db, NULL, GNUNET_ERROR_TYPE_ERROR, "sqlite3_prepare_v2");
 218       goto err_shutdown;
 219     }
 220   }
 221   if ( (SQLITE_OK != sqlite3_bind_text (stmt_insert, 1,
 222                                         GNUNET_i2s (&address->peer), -1,
 223                                         SQLITE_STATIC)) ||
 224         (SQLITE_OK != sqlite3_bind_int (stmt_insert, 2, latency)) )
 225   {
 226      LOG_SQLITE (db, NULL, GNUNET_ERROR_TYPE_ERROR, "sqlite3_bind_text");
 227      goto err_shutdown;
 228   }
 229   if (SQLITE_DONE != sqlite3_step (stmt_insert))
 230   {
 231     LOG_SQLITE (db, NULL, GNUNET_ERROR_TYPE_ERROR, "sqlite3_step");
 232     goto err_shutdown;
 233   }
 234   if (SQLITE_OK != sqlite3_reset (stmt_insert))
 235   {
 236     LOG_SQLITE (db, NULL, GNUNET_ERROR_TYPE_ERROR, "sqlite3_insert");
 237     goto err_shutdown;
 238   }
 239   if (NULL == entry)
 240   {
 241     entry = GNUNET_new (struct Entry);
 242     entry->id = address->peer;
 243     GNUNET_CONTAINER_multipeermap_put (map,
 244                                        &entry->id, entry,
 245                                        GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST);
 246   }
 247   entry->latency = latency;
 248   return;
 249
 250  err_shutdown:
 251       GNUNET_SCHEDULER_shutdown ();
 252 }
 253
 254
 255 /**
 256  * Main function that will be run.
 257  *
 258  * @param cls closure
 259  * @param args remaining command-line arguments
 260  * @param cfgfile name of the configuration file used (for saving, can be NULL!)
 261  * @param c configuration
 262  */
 263 static void
 264 run (void *cls, char *const *args, const char *cfgfile,
 265      const struct GNUNET_CONFIGURATION_Handle *c)
 266 {
 267   const char *query_create =
 268       "CREATE TABLE ats_info ("
 269       "id TEXT,"
 270       "val INTEGER,"
 271       "timestamp NUMERIC"
 272       ");";
 273   char *dbfile;
 274
 275   if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_filename (c, "LATENCY-LOGGER",
 276                                                             "DBFILE",
 277                                                             &dbfile))
 278   {
 279     GNUNET_break (0);
 280     return;
 281   }
 282   if (SQLITE_OK != sqlite3_open (dbfile, &db))
 283   {
 284     if (NULL != db)
 285     {
 286       LOG_SQLITE (db, NULL, GNUNET_ERROR_TYPE_ERROR, "sqlite_open_v2");
 287       GNUNET_break (SQLITE_OK == sqlite3_close (db));
 288     }
 289     else
 290       LOG (GNUNET_ERROR_TYPE_ERROR, "Cannot open sqlite file %s\n", dbfile);
 291     GNUNET_free (dbfile);
 292     return;
 293   }
 294   if (0 != sqlite3_exec (db, query_create, NULL, NULL, NULL))
 295     DEBUG ("SQLite Error: %d.  Perhaps the database `%s' already exits.\n",
 296            sqlite3_errcode (db), dbfile);
 297   DEBUG ("Opened database %s\n", dbfile);
 298   GNUNET_free (dbfile);
 299   dbfile = NULL;
 300   ats = GNUNET_ATS_performance_init (c, &addr_info_cb, NULL);
 301   map = GNUNET_CONTAINER_multipeermap_create (30, GNUNET_YES);
 302   shutdown_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
 303                                                 &do_shutdown, NULL);
 304 }
 305
 306
 307 /**
 308  * Execution entry point
 309  */
 310 int
 311 main (int argc, char * const *argv)
 312 {
 313   static const struct GNUNET_GETOPT_CommandLineOption options[] = {
 314     GNUNET_GETOPT_OPTION_END
 315   };
 316   int ret;
 317
 318   if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
 319     return 2;
 320   ret =
 321       (GNUNET_OK ==
 322        GNUNET_PROGRAM_run (argc, argv, "gnunet-daemon-latency-logger",
 323                            _("Daemon to log latency values of connections to neighbours"),
 324                            options, &run, NULL)) ? 0 : 1;
 325   GNUNET_free ((void*) argv);
 326   return ret;
 327 }