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

   1 /*
   2       This file is part of GNUnet
   3       Copyright (C) 2008--2014 GNUnet e.V.
   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 static struct GNUNET_ATS_PerformanceHandle *ats;
  93
  94 /**
  95  * Prepared statement for inserting values into the database table
  96  */
  97 static struct sqlite3_stmt *stmt_insert;
  98
  99
 100 /**
 101  * @ingroup hashmap
 102  * Iterator over hash map entries.
 103  *
 104  * @param cls closure
 105  * @param key current public key
 106  * @param value value in the hash map
 107  * @return #GNUNET_YES if we should continue to
 108  *         iterate,
 109  *         #GNUNET_NO if not.
 110  */
 111 static int
 112 free_iterator (void *cls,
 113                const struct GNUNET_PeerIdentity *key,
 114                void *value)
 115 {
 116   struct Entry *e = cls;
 117
 118   GNUNET_assert (GNUNET_YES ==
 119                  GNUNET_CONTAINER_multipeermap_remove (map, key, e));
 120   GNUNET_free (e);
 121   return GNUNET_YES;
 122 }
 123
 124
 125 /**
 126  * Shutdown
 127  *
 128  * @param cls NULL
 129  * @return
 130  */
 131 static void
 132 do_shutdown (void *cls)
 133 {
 134   GNUNET_ATS_performance_done (ats);
 135   ats = NULL;
 136   if (NULL != stmt_insert)
 137   {
 138     sqlite3_finalize (stmt_insert);
 139     stmt_insert = NULL;
 140   }
 141   GNUNET_break (SQLITE_OK == sqlite3_close (db));
 142   db = NULL;
 143   if (NULL != map)
 144   {
 145     GNUNET_assert (GNUNET_SYSERR !=
 146                    GNUNET_CONTAINER_multipeermap_iterate (map, free_iterator, NULL));
 147     GNUNET_CONTAINER_multipeermap_destroy (map);
 148     map = NULL;
 149   }
 150 }
 151
 152 /**
 153  * Signature of a function that is called with QoS information about an address.
 154  *
 155  * @param cls closure
 156  * @param address the address
 157  * @param address_active #GNUNET_YES if this address is actively used
 158  *        to maintain a connection to a peer;
 159  *        #GNUNET_NO if the address is not actively used;
 160  *        #GNUNET_SYSERR if this address is no longer available for ATS
 161  * @param bandwidth_out assigned outbound bandwidth for the connection
 162  * @param bandwidth_in assigned inbound bandwidth for the connection
 163  * @param prop performance data for the address (as far as known)
 164  */
 165 static void
 166 addr_info_cb (void *cls,
 167               const struct GNUNET_HELLO_Address *address,
 168               int address_active,
 169               struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
 170               struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
 171               const struct GNUNET_ATS_Properties *prop)
 172 {
 173   static const char *query_insert =
 174       "INSERT INTO ats_info("
 175       " id,"
 176       " val,"
 177       " timestamp"
 178       ") VALUES ("
 179       " ?1,"
 180       " ?2,"
 181       " datetime('now')"
 182       ");";
 183   struct Entry *entry;
 184   int latency; /* FIXME: type!? */
 185
 186   if (NULL == address)
 187   {
 188     /* ATS service temporarily disconnected */
 189     return;
 190   }
 191
 192   GNUNET_assert (NULL != db);
 193   if (GNUNET_YES != address_active)
 194     return;
 195   latency = (int) prop->delay.rel_value_us;
 196   entry = NULL;
 197   if (GNUNET_YES == GNUNET_CONTAINER_multipeermap_contains (map,
 198                                                             &address->peer))
 199   {
 200     entry = GNUNET_CONTAINER_multipeermap_get (map, &address->peer);
 201     GNUNET_assert (NULL != entry);
 202     if (latency == entry->latency)
 203       return;
 204   }
 205   if (NULL == stmt_insert)
 206   {
 207     if (SQLITE_OK != sqlite3_prepare_v2 (db, query_insert, -1, &stmt_insert,
 208                                          NULL))
 209     {
 210       LOG_SQLITE (db, NULL, GNUNET_ERROR_TYPE_ERROR, "sqlite3_prepare_v2");
 211       goto err_shutdown;
 212     }
 213   }
 214   if ( (SQLITE_OK != sqlite3_bind_text (stmt_insert, 1,
 215                                         GNUNET_i2s (&address->peer), -1,
 216                                         SQLITE_STATIC)) ||
 217         (SQLITE_OK != sqlite3_bind_int (stmt_insert, 2, latency)) )
 218   {
 219      LOG_SQLITE (db, NULL, GNUNET_ERROR_TYPE_ERROR, "sqlite3_bind_text");
 220      goto err_shutdown;
 221   }
 222   if (SQLITE_DONE != sqlite3_step (stmt_insert))
 223   {
 224     LOG_SQLITE (db, NULL, GNUNET_ERROR_TYPE_ERROR, "sqlite3_step");
 225     goto err_shutdown;
 226   }
 227   if (SQLITE_OK != sqlite3_reset (stmt_insert))
 228   {
 229     LOG_SQLITE (db, NULL, GNUNET_ERROR_TYPE_ERROR, "sqlite3_insert");
 230     goto err_shutdown;
 231   }
 232   if (NULL == entry)
 233   {
 234     entry = GNUNET_new (struct Entry);
 235     entry->id = address->peer;
 236     GNUNET_CONTAINER_multipeermap_put (map,
 237                                        &entry->id, entry,
 238                                        GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST);
 239   }
 240   entry->latency = latency;
 241   return;
 242
 243  err_shutdown:
 244       GNUNET_SCHEDULER_shutdown ();
 245 }
 246
 247
 248 /**
 249  * Main function that will be run.
 250  *
 251  * @param cls closure
 252  * @param args remaining command-line arguments
 253  * @param cfgfile name of the configuration file used (for saving, can be NULL!)
 254  * @param c configuration
 255  */
 256 static void
 257 run (void *cls, char *const *args, const char *cfgfile,
 258      const struct GNUNET_CONFIGURATION_Handle *c)
 259 {
 260   const char *query_create =
 261       "CREATE TABLE ats_info ("
 262       "id TEXT,"
 263       "val INTEGER,"
 264       "timestamp NUMERIC"
 265       ");";
 266   char *dbfile;
 267
 268   if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_filename (c, "LATENCY-LOGGER",
 269                                                             "DBFILE",
 270                                                             &dbfile))
 271   {
 272     GNUNET_break (0);
 273     return;
 274   }
 275   if (SQLITE_OK != sqlite3_open (dbfile, &db))
 276   {
 277     if (NULL != db)
 278     {
 279       LOG_SQLITE (db, NULL, GNUNET_ERROR_TYPE_ERROR, "sqlite_open_v2");
 280       GNUNET_break (SQLITE_OK == sqlite3_close (db));
 281     }
 282     else
 283       LOG (GNUNET_ERROR_TYPE_ERROR, "Cannot open sqlite file %s\n", dbfile);
 284     GNUNET_free (dbfile);
 285     return;
 286   }
 287   if (0 != sqlite3_exec (db, query_create, NULL, NULL, NULL))
 288     DEBUG ("SQLite Error: %d.  Perhaps the database `%s' already exits.\n",
 289            sqlite3_errcode (db), dbfile);
 290   DEBUG ("Opened database %s\n", dbfile);
 291   GNUNET_free (dbfile);
 292   dbfile = NULL;
 293   ats = GNUNET_ATS_performance_init (c, &addr_info_cb, NULL);
 294   map = GNUNET_CONTAINER_multipeermap_create (30, GNUNET_YES);
 295   GNUNET_SCHEDULER_add_shutdown (&do_shutdown, NULL);
 296 }
 297
 298
 299 /**
 300  * Execution entry point
 301  */
 302 int
 303 main (int argc, char * const *argv)
 304 {
 305   static const struct GNUNET_GETOPT_CommandLineOption options[] = {
 306     GNUNET_GETOPT_OPTION_END
 307   };
 308   int ret;
 309
 310   if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
 311     return 2;
 312   ret =
 313       (GNUNET_OK ==
 314        GNUNET_PROGRAM_run (argc, argv, "gnunet-daemon-latency-logger",
 315                            _("Daemon to log latency values of connections to neighbours"),
 316                            options, &run, NULL)) ? 0 : 1;
 317   GNUNET_free ((void*) argv);
 318   return ret;
 319 }