src/testbed/generate-underlay-topology.c

   1 /*
   2       This file is part of GNUnet
   3       (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., 59 Temple Place - Suite 330,
  18       Boston, MA 02111-1307, USA.
  19 */
  20
  21 /**
  22  * @file testbed/generate-underlay-topology.c
  23  * @brief Program to generate a database file containing given underlay topology
  24  * @author Sree Harsha Totakura <sreeharsha@totakura.in>
  25  */
  26
  27 #include "platform.h"
  28 #include "gnunet_util_lib.h"
  29 #include "gnunet_testbed_service.h"
  30 #include "testbed_api_topology.h"
  31 #include "sqlite3.h"
  32
  33 #define LOG(type, ...)                          \
  34   GNUNET_log (type, __VA_ARGS__)
  35
  36
  37 #define LOG_ERROR(...)                          \
  38   LOG (GNUNET_ERROR_TYPE_ERROR, __VA_ARGS__)
  39
  40 /**
  41  * Log an error message at log-level 'level' that indicates
  42  * a failure of the command 'cmd' on file 'filename'
  43  * with the message given by strerror(errno).
  44  */
  45 #define LOG_SQLITE(db, msg, level, cmd)                                 \
  46   do {                                                                  \
  47     GNUNET_log_from (level, "sqlite", _("`%s' failed at %s:%d with error: %s\n"), \
  48                      cmd, __FILE__,__LINE__, sqlite3_errmsg(db));  \
  49     if (msg != NULL)                                                    \
  50       GNUNET_asprintf(msg, _("`%s' failed at %s:%u with error: %s"), cmd, \
  51                       __FILE__, __LINE__, sqlite3_errmsg(db));     \
  52   } while(0)
  53
  54
  55 /**
  56  * Handle to the sqlite3 database
  57  */
  58 static struct sqlite3 *db;
  59
  60 /**
  61  * Prepared statement for inserting link values into db
  62  */
  63 struct sqlite3_stmt *stmt_insert;
  64
  65 /**
  66  * The topology to generate
  67  */
  68 enum GNUNET_TESTBED_TopologyOption topology;
  69
  70 /**
  71  * The number of peers to include in the topology
  72  */
  73 static int num_peers;
  74
  75 /**
  76  * program result
  77  */
  78 static int exit_result;
  79
  80
  81 /**
  82  * Functions of this type are called to process underlay link
  83  *
  84  * @param cls closure
  85  * @param A offset of first peer
  86  * @param B offset of second peer
  87  * @param bandwidth the bandwidth of the link in bytes per second
  88  * @param latency the latency of link in milliseconds
  89  * @param loss the percentage of messages dropped on the link
  90  * @return GNUNET_OK to continue processing; GNUNET_SYSERR to abort
  91  */
  92 static int
  93 link_processor (void *cls,
  94                 unsigned int A,
  95                 unsigned int B,
  96                 unsigned int bandwidth,
  97                 unsigned int latency,
  98                 unsigned int loss)
  99 {
 100   if ( (SQLITE_OK != sqlite3_bind_int (stmt_insert, 1, A)) ||
 101        (SQLITE_OK != sqlite3_bind_int (stmt_insert, 2, B)) ||
 102        (SQLITE_OK != sqlite3_bind_int (stmt_insert, 3, bandwidth)) ||
 103        (SQLITE_OK != sqlite3_bind_int (stmt_insert, 4, latency)) ||
 104        (SQLITE_OK != sqlite3_bind_int (stmt_insert, 5, loss)) )
 105   {
 106     LOG_SQLITE (db, NULL, GNUNET_ERROR_TYPE_ERROR, "sqlite3_bind_int");
 107     return GNUNET_SYSERR;
 108   }
 109   if (SQLITE_DONE != sqlite3_step (stmt_insert))
 110   {
 111     LOG_SQLITE (db, NULL, GNUNET_ERROR_TYPE_ERROR, "sqlite3_step");
 112     return GNUNET_SYSERR;
 113   }
 114   FPRINTF (stdout, "%u -> %u\n", A, B);
 115   GNUNET_break (SQLITE_OK == sqlite3_reset (stmt_insert));
 116   //GNUNET_break (SQLITE_OK == sqlite3_clear_bindings (stmt_insert));
 117   return GNUNET_OK;
 118 }
 119
 120
 121 /**
 122  * Open the database file, creating a new database if not existing and setup the
 123  * whitelist table
 124  *
 125  * @param dbfile the database filename
 126  * @return GNUNET_OK upon success; GNUNET_SYSERR upon failure (error message has
 127  * to be printed)
 128  */
 129 static int
 130 setup_db (const char *dbfile)
 131 {
 132   const char *query_create =
 133       "CREATE TABLE whitelist ("
 134       "id INTEGER,"
 135       "oid INTEGER,"
 136       "bandwidth INTEGER DEFAULT NULL,"
 137       "latency INTEGER DEFAULT NULL,"
 138       "loss INTEGER DEFAULT NULL);";
 139   const char *query_insert =
 140       "INSERT INTO whitelist("
 141       " id,"
 142       " oid,"
 143       " bandwidth,"
 144       " latency,"
 145       " loss"
 146       ") VALUES ("
 147       " ?1,"
 148       " ?2,"
 149       " ?3,"
 150       " ?4,"
 151       " ?5);";
 152   struct sqlite3_stmt *stmt_create;
 153   int ret;
 154
 155   stmt_create = NULL;
 156   if (SQLITE_OK != (ret = sqlite3_open (dbfile, &db)))
 157   {
 158     LOG_SQLITE (db, NULL, GNUNET_ERROR_TYPE_ERROR, "sqlite3_open");
 159     goto err_ret;
 160   }
 161   if (SQLITE_OK != (ret = sqlite3_prepare_v2 (db, query_create, -1,
 162                                               &stmt_create, NULL)))
 163   {
 164     LOG_SQLITE (db, NULL, GNUNET_ERROR_TYPE_ERROR, "sqlite3_prepare_v2");
 165     goto err_ret;
 166   }
 167   if (SQLITE_DONE != sqlite3_step (stmt_create))
 168   {
 169     LOG_SQLITE (db, NULL, GNUNET_ERROR_TYPE_ERROR, "sqlite3_step");
 170     goto err_ret;
 171   }
 172   if (SQLITE_OK != (ret = sqlite3_prepare_v2 (db, query_insert, -1,
 173                                               &stmt_insert, NULL)))
 174   {
 175     LOG_SQLITE (db, NULL, GNUNET_ERROR_TYPE_ERROR, "sqlite3_prepare_v2");
 176     goto err_ret;
 177   }
 178
 179  err_ret:
 180   if (NULL != stmt_create)
 181     sqlite3_finalize (stmt_create);
 182   return (SQLITE_OK != ret) ? GNUNET_SYSERR : GNUNET_OK;
 183 }
 184
 185
 186 /**
 187  * Main run function.
 188  *
 189  * @param cls NULL
 190  * @param args arguments passed to GNUNET_PROGRAM_run
 191  * @param cfgfile the path to configuration file
 192  * @param cfg the configuration file handle
 193  */
 194 static void
 195 run (void *cls, char *const *args, const char *cfgfile,
 196      const struct GNUNET_CONFIGURATION_Handle *config)
 197 {
 198   const char *dbfile;
 199   const char *topology_string;
 200   unsigned int arg_uint1;
 201   unsigned int arg_uint2;
 202   const char *arg_str1;
 203   const char *value;
 204   unsigned int argc;
 205
 206   argc = 0;
 207   if (NULL == args)
 208   {
 209     LOG_ERROR (_("Need atleast 2 arguments\n"));
 210     return;
 211   }
 212   if (NULL == (dbfile = args[argc++]))
 213   {
 214     LOG_ERROR (_("Database filename missing\n"));
 215     return;
 216   }
 217   if (GNUNET_OK != setup_db (dbfile))
 218     return;
 219   if (NULL == (topology_string = args[argc++]))
 220   {
 221     LOG_ERROR (_("Topology string missing\n"));
 222     return;
 223   }
 224   if (GNUNET_YES != GNUNET_TESTBED_topology_get_ (&topology, topology_string))
 225   {
 226     LOG_ERROR (_("Invalid topology: %s\n"), topology_string);
 227     return;
 228   }
 229   /* parse for first TOPOOPT.  This can either be arg_uint1 or arg_str1 */
 230   switch (topology)
 231   {
 232   case GNUNET_TESTBED_TOPOLOGY_ERDOS_RENYI:
 233   case GNUNET_TESTBED_TOPOLOGY_SMALL_WORLD_RING:
 234   case GNUNET_TESTBED_TOPOLOGY_SMALL_WORLD:
 235   case GNUNET_TESTBED_TOPOLOGY_SCALE_FREE:
 236     if (NULL == (value = args[argc++]))
 237     {
 238       LOG_ERROR (_("An argument is missing for given topology `%s'\n"),
 239                  topology_string);
 240       return;
 241     }
 242     if (-1 == SSCANF (value, "%u", &arg_uint1))
 243     {
 244       LOG_ERROR (_("Invalid argument `%s' given as topology argument\n"),
 245                  value);
 246       return;
 247     }
 248     break;
 249   case GNUNET_TESTBED_TOPOLOGY_FROM_FILE:
 250     if (NULL == (arg_str1 = args[argc++]))
 251     {
 252       LOG_ERROR (_("Filename argument missing for topology `%s'\n"),
 253                  topology_string);
 254       return;
 255     }
 256     break;
 257   default:
 258     GNUNET_assert (0);
 259   }
 260   /* parse for second TOPOOPT.  Only required for SCALE_FREE topology */
 261   switch (topology)
 262   {
 263   case GNUNET_TESTBED_TOPOLOGY_SCALE_FREE:
 264     if (NULL == (value = args[argc++]))
 265     {
 266       LOG_ERROR (_("Second argument for topology `%s' is missing\n"),
 267                  topology_string);
 268       return;
 269     }
 270     if (-1 == SSCANF (value, "%u", &arg_uint2))
 271     {
 272       LOG_ERROR (_("Invalid argument `%s'; expecting unsigned int\n"), value);
 273       return;
 274     }
 275     break;
 276   default:
 277     break;
 278   }
 279   /* contruct topologies */
 280   switch (topology)
 281   {
 282   case GNUNET_TESTBED_TOPOLOGY_LINE:
 283   case GNUNET_TESTBED_TOPOLOGY_RING:
 284   case GNUNET_TESTBED_TOPOLOGY_CLIQUE:
 285   case GNUNET_TESTBED_TOPOLOGY_2D_TORUS:
 286     GNUNET_TESTBED_underlay_construct_ (num_peers, link_processor, NULL,
 287                                         topology);
 288     break;
 289   case GNUNET_TESTBED_TOPOLOGY_ERDOS_RENYI:
 290   case GNUNET_TESTBED_TOPOLOGY_SMALL_WORLD_RING:
 291   case GNUNET_TESTBED_TOPOLOGY_SMALL_WORLD:
 292     GNUNET_TESTBED_underlay_construct_ (num_peers, link_processor, NULL,
 293                                         topology,
 294                                         arg_uint1);
 295     break;
 296   case GNUNET_TESTBED_TOPOLOGY_FROM_FILE:
 297     GNUNET_TESTBED_underlay_construct_ (num_peers, link_processor, NULL,
 298                                         topology,
 299                                         arg_str1);
 300     break;
 301   case GNUNET_TESTBED_TOPOLOGY_SCALE_FREE:
 302     GNUNET_TESTBED_underlay_construct_ (num_peers, link_processor, NULL,
 303                                         topology,
 304                                         arg_uint1,
 305                                         arg_uint2);
 306     break;
 307   default:
 308     GNUNET_assert (0);
 309   }
 310 }
 311
 312
 313 /**
 314  * Main
 315  */
 316 int
 317 main (int argc, char *const argv[])
 318 {
 319   struct GNUNET_GETOPT_CommandLineOption option[] = {
 320     {'p', "num-peers", "COUNT",
 321      gettext_noop ("create COUNT number of peers"),
 322      GNUNET_YES, &GNUNET_GETOPT_set_uint, &num_peers},
 323     GNUNET_GETOPT_OPTION_END
 324   };
 325   int ret;
 326
 327   exit_result = GNUNET_SYSERR;
 328   ret =
 329       GNUNET_PROGRAM_run (argc, argv, "gnunet-underlay-topology",
 330                           _("Generates SQLite3 database representing a given underlay topology.\n"
 331                             "Usage: gnunet-underlay-topology [OPTIONS] db-filename TOPO [TOPOOPTS]\n"
 332                             "The following options are available for TOPO followed by TOPOOPTS if applicable:\n"
 333                             "\t LINE\n"
 334                             "\t RING\n"
 335                             "\t RANDOM <num_rnd_links>\n"
 336                             "\t SMALL_WORLD <num_rnd_links>\n"
 337                             "\t SMALL_WORLD_RING <num_rnd_links>\n"
 338                             "\t CLIQUE\n"
 339                             "\t 2D_TORUS\n"
 340                             "\t SCALE_FREE <cap> <m>\n"
 341                             "\t FROM_FILE <filename>\n"
 342                             "TOPOOPTS:\n"
 343                             "\t num_rnd_links: The number of random links\n"
 344                             "\t cap: the maximum number of links a node can have\n"
 345                             "\t m: the number of links a node should have while joining the network\n"
 346                             "\t filename: the path of the file which contains topology information\n"
 347                             "NOTE: the format of the above file is descibed here: https://www.gnunet.org/content/topology-file-format\n"),
 348                           option, &run, NULL);
 349   if (NULL != stmt_insert)
 350     sqlite3_finalize (stmt_insert);
 351   if (NULL != db)
 352     sqlite3_close (db);
 353   if ((GNUNET_OK != ret) || (GNUNET_OK != exit_result))
 354     return 1;
 355   return 0;
 356 }