ats-tool/gnunet-ats.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2001, 2002, 2004, 2005, 2006, 2007, 2009 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 ats-tool/gnunet-ats.c
  23  * @brief ATS command line tool
  24  * @author Matthias Wachs
  25  */
  26 #include "platform.h"
  27 #include "gnunet_util_lib.h"
  28 #include "gnunet_ats_service.h"
  29 #include "gnunet_transport_service.h"
  30
  31 #define TIMEOUT GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_SECONDS, 5)
  32
  33 #define BIG_M_STRING "unlimited"
  34
  35 /**
  36  * Final status code.
  37  */
  38 static int ret;
  39 static int results;
  40 static int resolve_addresses_numeric;
  41 static int receive_done;
  42
  43 /**
  44  * For which peer should we change preference values?
  45  */
  46 static char *pid_str;
  47
  48 static char *type_str;
  49 static unsigned int value;
  50 static int pending;
  51
  52 /**
  53  * Print verbose ATS information
  54  */
  55 static int verbose;
  56
  57 /**
  58  * List only addresses currently used (active)
  59  */
  60 static int op_list_used;
  61
  62 /**
  63  * List all addresses
  64  */
  65 static int op_list_all;
  66
  67 /**
  68  * List all addresses
  69  */
  70 static int op_set_pref;
  71
  72 /**
  73  * Print quotas configured
  74  */
  75 static int op_print_quotas;
  76
  77 /**
  78  * Monitor addresses used
  79  */
  80 static int op_monitor;
  81
  82
  83
  84 static struct GNUNET_ATS_PerformanceHandle *ph;
  85
  86 struct GNUNET_ATS_AddressListHandle *alh;
  87
  88 static struct GNUNET_CONFIGURATION_Handle *cfg;
  89
  90 GNUNET_SCHEDULER_TaskIdentifier end_task;
  91
  92 struct PendingResolutions
  93 {
  94   struct PendingResolutions *next;
  95   struct PendingResolutions *prev;
  96
  97   struct GNUNET_HELLO_Address *address;
  98   struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out;
  99   struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in;
 100
 101   struct GNUNET_ATS_Information *ats;
 102   uint32_t ats_count;
 103
 104   struct GNUNET_TRANSPORT_AddressToStringContext * tats_ctx;
 105 };
 106
 107 struct PendingResolutions *head;
 108 struct PendingResolutions *tail;
 109
 110 void end (void *cls,
 111           const struct GNUNET_SCHEDULER_TaskContext *tc)
 112 {
 113   struct PendingResolutions * pr;
 114   struct PendingResolutions * next;
 115   unsigned int pending;
 116
 117   if (NULL != alh)
 118   {
 119       GNUNET_ATS_performance_list_addresses_cancel (alh);
 120       alh = NULL;
 121   }
 122
 123   if (NULL != ph)
 124   {
 125     GNUNET_ATS_performance_done (ph);
 126     ph = NULL;
 127   }
 128
 129   pending = 0;
 130   next = head;
 131   while (NULL != (pr = next))
 132   {
 133       next = pr->next;
 134       GNUNET_CONTAINER_DLL_remove (head, tail, pr);
 135       GNUNET_TRANSPORT_address_to_string_cancel (pr->tats_ctx);
 136       GNUNET_free (pr->address);
 137       GNUNET_free (pr);
 138       pending ++;
 139   }
 140   if (0 < pending)
 141     fprintf (stderr, _("%u address resolutions had a timeout\n"), pending);
 142
 143   fprintf (stderr, _("ATS returned results for %u addresses\n"), results);
 144   ret = 0;
 145 }
 146
 147
 148 void transport_addr_to_str_cb (void *cls, const char *address)
 149 {
 150   struct PendingResolutions * pr = cls;
 151   char *ats_str;
 152   char *ats_tmp;
 153   char *ats_prop_arr[GNUNET_ATS_PropertyCount] = GNUNET_ATS_PropertyStrings;
 154   char *ats_prop_value;
 155   unsigned int c;
 156   uint32_t ats_type;
 157   uint32_t ats_value;
 158   uint32_t network;
 159   if (NULL != address)
 160   {
 161     ats_str = GNUNET_strdup("");
 162
 163
 164     for (c = 0; c < pr->ats_count; c++)
 165     {
 166         ats_tmp = ats_str;
 167
 168         ats_type = ntohl(pr->ats[c].type);
 169         ats_value = ntohl(pr->ats[c].value);
 170
 171         if (ats_type > GNUNET_ATS_PropertyCount)
 172         {
 173             GNUNET_break (0);
 174             continue;
 175         }
 176
 177         switch (ats_type) {
 178           case GNUNET_ATS_NETWORK_TYPE:
 179             if (ats_value > GNUNET_ATS_NetworkTypeCount)
 180             {
 181                 GNUNET_break (0);
 182                 continue;
 183             }
 184             network = ats_value;
 185             GNUNET_asprintf (&ats_prop_value, "%s", GNUNET_ATS_print_network_type(ats_value));
 186             break;
 187           default:
 188             GNUNET_asprintf (&ats_prop_value, "%u", ats_value);
 189             break;
 190         }
 191         if ((verbose) && (ats_type < GNUNET_ATS_PropertyCount))
 192         {
 193           GNUNET_asprintf (&ats_str, "%s%s=%s, ", ats_tmp, ats_prop_arr[ats_type] , ats_prop_value);
 194           GNUNET_free (ats_tmp);
 195         }
 196         GNUNET_free (ats_prop_value);
 197                 }
 198
 199     fprintf (stderr, _("Peer `%s' plugin `%s', address `%s', `%s' bw out: %u Bytes/s, bw in %u Bytes/s, %s\n"),
 200       GNUNET_i2s (&pr->address->peer), pr->address->transport_name, address,
 201       GNUNET_ATS_print_network_type(network),
 202       ntohl (pr->bandwidth_out.value__), ntohl (pr->bandwidth_in.value__),ats_str);
 203     GNUNET_free (ats_str);
 204   }
 205   else
 206   {
 207     /* We're done */
 208     GNUNET_CONTAINER_DLL_remove (head, tail, pr);
 209     GNUNET_free (pr->address);
 210     GNUNET_free (pr);
 211     pending--;
 212
 213     if ((GNUNET_YES == receive_done) && (0 == pending))
 214     {
 215         /* All messages received and no resolutions pending*/
 216         if (end_task != GNUNET_SCHEDULER_NO_TASK)
 217           GNUNET_SCHEDULER_cancel (end_task);
 218         end_task = GNUNET_SCHEDULER_add_now (end, NULL);
 219     }
 220   }
 221 }
 222
 223 void ats_perf_cb (void *cls,
 224                   const struct
 225                   GNUNET_HELLO_Address *
 226                   address,
 227                   struct
 228                   GNUNET_BANDWIDTH_Value32NBO
 229                   bandwidth_out,
 230                   struct
 231                   GNUNET_BANDWIDTH_Value32NBO
 232                   bandwidth_in,
 233                   const struct
 234                   GNUNET_ATS_Information *
 235                   ats, uint32_t ats_count)
 236 {
 237   struct PendingResolutions * pr;
 238
 239
 240   if (NULL != address)
 241   {
 242     pr = GNUNET_malloc (sizeof (struct PendingResolutions) +
 243                         ats_count * sizeof (struct GNUNET_ATS_Information));
 244
 245     pr->ats_count = ats_count;
 246     pr->ats = (struct GNUNET_ATS_Information *) &pr[1];
 247     if (ats_count > 0)
 248       memcpy (pr->ats, ats, ats_count * sizeof (struct GNUNET_ATS_Information));
 249     pr->address = GNUNET_HELLO_address_copy (address);
 250     pr->bandwidth_in = bandwidth_in;
 251     pr->bandwidth_out = bandwidth_out;
 252     pr->tats_ctx = GNUNET_TRANSPORT_address_to_string(cfg, address,
 253                       resolve_addresses_numeric, GNUNET_TIME_UNIT_FOREVER_REL, transport_addr_to_str_cb, pr);
 254     GNUNET_CONTAINER_DLL_insert (head, tail, pr);
 255     results++;
 256     pending++;
 257   }
 258   else
 259   {
 260     /* All messages received */
 261     receive_done = GNUNET_YES;
 262     alh = NULL;
 263     if (0 == pending)
 264     {
 265       /* All messages received and no resolutions pending*/
 266       if (end_task != GNUNET_SCHEDULER_NO_TASK)
 267         GNUNET_SCHEDULER_cancel (end_task);
 268       end_task = GNUNET_SCHEDULER_add_now (end, NULL);
 269     }
 270   }
 271 }
 272
 273 static unsigned int
 274 print_quotas (const struct GNUNET_CONFIGURATION_Handle *cfg)
 275 {
 276   char *network_str[GNUNET_ATS_NetworkTypeCount] = GNUNET_ATS_NetworkTypeString;
 277   char * entry_in = NULL;
 278   char * entry_out = NULL;
 279   char * quota_out_str;
 280   char * quota_in_str;
 281   unsigned long long int quota_out;
 282   unsigned long long int quota_in;
 283   int c;
 284
 285   for (c = 0; (c < GNUNET_ATS_NetworkTypeCount); c++)
 286   {
 287
 288     GNUNET_asprintf (&entry_out, "%s_QUOTA_OUT", network_str[c]);
 289     GNUNET_asprintf (&entry_in, "%s_QUOTA_IN", network_str[c]);
 290
 291     /* quota out */
 292     if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string(cfg, "ats", entry_out, &quota_out_str))
 293     {
 294       if (0 == strcmp(quota_out_str, BIG_M_STRING) ||
 295           (GNUNET_SYSERR == GNUNET_STRINGS_fancy_size_to_bytes (quota_out_str, &quota_out)))
 296         quota_out = UINT32_MAX;
 297
 298       GNUNET_free (quota_out_str);
 299       GNUNET_asprintf (&quota_out_str, "%llu", quota_out);
 300     }
 301     else
 302     {
 303         fprintf (stderr, "Outbound quota for network `%11s' not configured!\n",
 304             network_str[c]);
 305         GNUNET_asprintf (&quota_out_str, "-");
 306     }
 307     GNUNET_free (entry_out);
 308
 309     /* quota in */
 310     if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string(cfg, "ats", entry_in, &quota_in_str))
 311     {
 312       if (0 == strcmp(quota_in_str, BIG_M_STRING) ||
 313           (GNUNET_SYSERR == GNUNET_STRINGS_fancy_size_to_bytes (quota_in_str, &quota_in)))
 314           quota_in = UINT32_MAX;
 315       GNUNET_free (quota_in_str);
 316       GNUNET_asprintf (&quota_in_str, "%llu", quota_in);
 317     }
 318     else
 319     {
 320         fprintf (stderr, "Inbound quota for network `%11s' not configured!\n",
 321             network_str[c]);
 322         GNUNET_asprintf (&quota_in_str, "-");
 323     }
 324     GNUNET_free (entry_in);
 325
 326     fprintf (stderr, _("Quota for network `%11s' (in/out): %10s / %10s\n"), network_str[c], quota_in_str, quota_out_str );
 327     GNUNET_free (quota_out_str);
 328     GNUNET_free (quota_in_str);
 329   }
 330   return GNUNET_ATS_NetworkTypeCount;
 331 }
 332
 333
 334
 335 void testservice_ats (void *cls,
 336                const struct GNUNET_SCHEDULER_TaskContext *tc)
 337 {
 338   struct GNUNET_PeerIdentity pid;
 339   struct GNUNET_CONFIGURATION_Handle *cfg = cls;
 340   unsigned int c;
 341   unsigned int type;
 342
 343   if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_TIMEOUT))
 344   {
 345       FPRINTF (stderr, _("Service `%s' is not running\n"), "ats");
 346       return;
 347   }
 348
 349   results = 0;
 350
 351   if (NULL != pid_str)
 352   {
 353       if (GNUNET_OK != GNUNET_CRYPTO_hash_from_string (pid_str, &pid.hashPubKey))
 354       {
 355         FPRINTF (stderr, _("Failed to parse peer identity `%s'\n"), pid_str);
 356         return;
 357       }
 358   }
 359
 360   c = op_list_all + op_list_used + op_monitor + op_set_pref;
 361   if ((1 < c))
 362   {
 363       FPRINTF (stderr, _("Please select one operation : %s or %s or %s or %s or %s\n"),
 364                "--used", "--all", "--monitor", "--preference", "--quotas");
 365       return;
 366   }
 367   if ((0 == c))
 368     op_list_used = GNUNET_YES; /* set default */
 369     if (op_print_quotas)
 370     {
 371         ret = print_quotas (cfg);
 372         return;
 373     }
 374     if (op_list_all)
 375     {
 376         ph = GNUNET_ATS_performance_init (cfg, NULL, NULL);
 377         if (NULL == ph)
 378         {
 379           fprintf (stderr, _("Cannot connect to ATS service, exiting...\n"));
 380           return;
 381         }
 382
 383         alh = GNUNET_ATS_performance_list_addresses (ph,
 384                                                (NULL == pid_str) ? NULL : &pid,
 385                                                GNUNET_YES, ats_perf_cb, NULL);
 386         if (NULL == alh)
 387         {
 388           fprintf (stderr, _("Cannot issue request to ATS service, exiting...\n"));
 389           end_task = GNUNET_SCHEDULER_add_now (&end, NULL);
 390           return;
 391         }
 392         end_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &end, NULL);
 393     }
 394     else if (op_list_used)
 395     {
 396         ph = GNUNET_ATS_performance_init (cfg, NULL, NULL);
 397         if (NULL == ph)
 398           fprintf (stderr, _("Cannot connect to ATS service, exiting...\n"));
 399
 400         alh = GNUNET_ATS_performance_list_addresses (ph,
 401                                                (NULL == pid_str) ? NULL : &pid,
 402                                                GNUNET_NO, ats_perf_cb, NULL);
 403         if (NULL == alh)
 404         {
 405           fprintf (stderr, _("Cannot issue request to ATS service, exiting...\n"));
 406           end_task = GNUNET_SCHEDULER_add_now (&end, NULL);
 407           return;
 408         }
 409         end_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &end, NULL);
 410     }
 411     else if (op_monitor)
 412     {
 413         ph = GNUNET_ATS_performance_init (cfg, ats_perf_cb, NULL);
 414         if (NULL == ph)
 415           fprintf (stderr, _("Cannot connect to ATS service, exiting...\n"));
 416         end_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &end, NULL);
 417
 418     }
 419     else if (op_set_pref)
 420     {
 421         for (c = 0; c<strlen(type_str); c++)
 422         {
 423           if (isupper (type_str[c]))
 424             type_str[c] = tolower (type_str[c]);
 425         }
 426
 427         if (0 == strcasecmp("latency", type_str))
 428           type = GNUNET_ATS_PREFERENCE_LATENCY;
 429         else if (0 == strcasecmp("bandwidth", type_str))
 430           type = GNUNET_ATS_PREFERENCE_BANDWIDTH;
 431         else
 432         {
 433           FPRINTF (stderr, "%s", _("Type required\n"));
 434           return;
 435         }
 436
 437             /* set */
 438             ph = GNUNET_ATS_performance_init (cfg, NULL, NULL);
 439             if (NULL == ph)
 440               fprintf (stderr, _("Cannot connect to ATS service, exiting...\n"));
 441
 442             GNUNET_ATS_change_preference (ph, &pid, type, (double) value, GNUNET_ATS_PREFERENCE_END);
 443
 444             end_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS, &end, NULL);
 445     }
 446   ret = 1;
 447 }
 448
 449 /**
 450  * Main function that will be run by the scheduler.
 451  *
 452  * @param cls closure
 453  * @param args remaining command-line arguments
 454  * @param cfgfile name of the configuration file used (for saving, can be NULL!)
 455  * @param my_cfg configuration
 456  */
 457 static void
 458 run (void *cls, char *const *args, const char *cfgfile,
 459      const struct GNUNET_CONFIGURATION_Handle *my_cfg)
 460 {
 461   cfg = (struct GNUNET_CONFIGURATION_Handle *) my_cfg;
 462   GNUNET_CLIENT_service_test ("ats", cfg,
 463                               TIMEOUT,
 464                               &testservice_ats,
 465                               (void *) cfg);
 466 }
 467
 468
 469 /**
 470  * The main function.
 471  *
 472  * @param argc number of arguments from the command line
 473  * @param argv command line arguments
 474  * @return 0 ok, 1 on error
 475  */
 476 int
 477 main (int argc, char *const *argv)
 478 {
 479   int res;
 480   resolve_addresses_numeric = GNUNET_NO;
 481   op_monitor = GNUNET_NO;
 482   op_list_all = GNUNET_NO;
 483   op_list_used = GNUNET_NO;
 484   op_set_pref = GNUNET_NO;
 485   pending = 0;
 486   receive_done = GNUNET_NO;
 487
 488   static const struct GNUNET_GETOPT_CommandLineOption options[] = {
 489       {'u', "used", NULL,
 490        gettext_noop ("get list of active addresses currently used"),
 491        0, &GNUNET_GETOPT_set_one, &op_list_used},
 492        {'a', "all", NULL,
 493         gettext_noop ("get list of all active addresses"),
 494         0, &GNUNET_GETOPT_set_one, &op_list_all},
 495       {'n', "numeric", NULL,
 496        gettext_noop ("do not resolve IP addresses to hostnames"),
 497        0, &GNUNET_GETOPT_set_one, &resolve_addresses_numeric},
 498        {'m', "monitor", NULL,
 499         gettext_noop ("monitor mode"),
 500         0, &GNUNET_GETOPT_set_one, &op_monitor},
 501        {'p', "preference", NULL,
 502          gettext_noop ("set preference for the given peer"),
 503          0, &GNUNET_GETOPT_set_one, &op_set_pref},
 504        {'q', "quotas", NULL,
 505          gettext_noop ("print all configured quotas"),
 506          0, &GNUNET_GETOPT_set_one, &op_print_quotas},
 507        {'i', "id", "TYPE",
 508          gettext_noop ("peer id"),
 509          1, &GNUNET_GETOPT_set_string, &pid_str},
 510        {'t', "type", "TYPE",
 511          gettext_noop ("preference type to set: latency | bandwidth"),
 512          1, &GNUNET_GETOPT_set_string, &type_str},
 513        {'k', "value", "VALUE",
 514          gettext_noop ("preference value"),
 515          1, &GNUNET_GETOPT_set_uint, &value},
 516        {'V', "verbose", NULL,
 517         gettext_noop ("verbose output (include ATS address properties)"),
 518         0, &GNUNET_GETOPT_set_one, &verbose},
 519     GNUNET_GETOPT_OPTION_END
 520   };
 521
 522   if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
 523     return 2;
 524
 525   res = GNUNET_PROGRAM_run (argc, argv, "gnunet-ats",
 526                               gettext_noop ("Print information about ATS state"), options, &run,
 527                               NULL);
 528   GNUNET_free_non_null (pid_str);
 529   GNUNET_free_non_null (type_str);
 530   GNUNET_free ((void *) argv);
 531
 532   if (GNUNET_OK == res)
 533     return ret;
 534   else
 535     return 1;
 536
 537 }
 538
 539 /* end of gnunet-ats.c */