src/ats/test_ats_api_scheduling.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2010,2011 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  * @file ats/test_ats_api_scheduling.c
  22  * @brief test automatic transport selection scheduling API
  23  * @author Christian Grothoff
  24  * @author Matthias Wachs
  25  *
  26  * TODO:
  27  * - write test case
  28  * - extend API to get performance data
  29  * - implement simplistic strategy based on say 'lowest latency' or strict ordering
  30  * - extend API to get peer preferences, implement proportional bandwidth assignment
  31  * - re-implement API against a real ATS service (!)
  32  */
  33 #include "platform.h"
  34 #include "gnunet_ats_service.h"
  35 #include "ats.h"
  36
  37 #define TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 10)
  38
  39 static GNUNET_SCHEDULER_TaskIdentifier die_task;
  40
  41 static struct GNUNET_ATS_SchedulingHandle *ats;
  42
  43 struct GNUNET_OS_Process *arm_proc;
  44
  45
  46
  47 static int ret;
  48
  49 struct Address
  50 {
  51   char *plugin;
  52   size_t plugin_len;
  53
  54   void *addr;
  55   size_t addr_len;
  56
  57   struct GNUNET_ATS_Information *ats;
  58   int ats_count;
  59
  60   void *session;
  61 };
  62
  63 struct PeerContext
  64 {
  65   struct GNUNET_PeerIdentity id;
  66
  67   struct Address *addr;
  68 };
  69
  70 struct Address addr[2];
  71 struct PeerContext p[2];
  72 struct GNUNET_ATS_Information atsi[2];
  73
  74 static void
  75 stop_arm ()
  76 {
  77   if (0 != GNUNET_OS_process_kill (arm_proc, SIGTERM))
  78     GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "kill");
  79   GNUNET_OS_process_wait (arm_proc);
  80   GNUNET_OS_process_destroy (arm_proc);
  81   arm_proc = NULL;
  82 }
  83
  84
  85 static void
  86 end_badly (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
  87 {
  88   die_task = GNUNET_SCHEDULER_NO_TASK;
  89   if (ats != NULL)
  90     GNUNET_ATS_scheduling_done (ats);
  91
  92   ret = GNUNET_SYSERR;
  93
  94   stop_arm ();
  95 }
  96
  97
  98 static void
  99 end ()
 100 {
 101   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Shutting down\n");
 102   if (die_task != GNUNET_SCHEDULER_NO_TASK)
 103   {
 104     GNUNET_SCHEDULER_cancel (die_task);
 105     die_task = GNUNET_SCHEDULER_NO_TASK;
 106   }
 107
 108   GNUNET_ATS_scheduling_done (ats);
 109
 110   ret = 0;
 111
 112   stop_arm ();
 113 }
 114
 115
 116 static void
 117 address_suggest_cb (void *cls, const struct GNUNET_HELLO_Address *address,
 118                     struct Session *session,
 119                     struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
 120                     struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
 121                     const struct GNUNET_ATS_Information *ats,
 122                     uint32_t ats_count)
 123 {
 124   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "ATS suggests address `%s'\n",
 125               GNUNET_i2s (&address->peer));
 126
 127   GNUNET_assert (0 ==
 128                  memcmp (&address->peer, &p[0].id,
 129                          sizeof (struct GNUNET_PeerIdentity)));
 130   GNUNET_assert (0 == strcmp (address->transport_name, addr[0].plugin));
 131   GNUNET_assert (address->address_length == addr[0].addr_len);
 132   GNUNET_assert (0 ==
 133                  memcmp (address->address, addr[0].plugin,
 134                          address->address_length));
 135   GNUNET_assert (addr[0].session == session);
 136
 137
 138   /* TODO ats merge
 139    * GNUNET_assert (ats_count == 2);
 140    * GNUNET_assert (atsi[0].type == htons (1));
 141    * GNUNET_assert (atsi[0].type == htons (2));
 142    * GNUNET_assert (atsi[1].type == htons (2));
 143    * GNUNET_assert (atsi[1].type == htons (2));
 144    */
 145
 146   ret = 0;
 147
 148   GNUNET_SCHEDULER_add_now (&end, NULL);
 149 }
 150
 151 void
 152 start_arm (const char *cfgname)
 153 {
 154   arm_proc =
 155     GNUNET_OS_start_process (GNUNET_YES, NULL, NULL, "gnunet-service-arm",
 156                                "gnunet-service-arm",
 157                                "-c", cfgname, NULL);
 158 }
 159
 160 static void
 161 check (void *cls, char *const *args, const char *cfgfile,
 162        const struct GNUNET_CONFIGURATION_Handle *cfg)
 163 {
 164   struct GNUNET_HELLO_Address address0;
 165
 166   ret = GNUNET_SYSERR;
 167
 168   die_task = GNUNET_SCHEDULER_add_delayed (TIMEOUT, &end_badly, NULL);
 169   start_arm (cfgfile);
 170
 171   ats = GNUNET_ATS_scheduling_init (cfg, &address_suggest_cb, NULL);
 172
 173   if (ats == NULL)
 174   {
 175     ret = GNUNET_SYSERR;
 176     end ();
 177     return;
 178   }
 179
 180   /* set up peer */
 181   GNUNET_CRYPTO_hash_create_random (GNUNET_CRYPTO_QUALITY_WEAK,
 182                                     &p[0].id.hashPubKey);
 183   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Created peer `%s'\n",
 184               GNUNET_i2s (&p[0].id));
 185
 186   GNUNET_CRYPTO_hash_create_random (GNUNET_CRYPTO_QUALITY_WEAK,
 187                                     &p[1].id.hashPubKey);
 188   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Created peer `%s'\n",
 189               GNUNET_i2s (&p[1].id));
 190
 191   addr[0].plugin = "test";
 192   addr[0].session = NULL;
 193   addr[0].addr = GNUNET_strdup ("test");
 194   addr[0].addr_len = 4;
 195
 196   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Testing address creation\n");
 197
 198   address0.peer = p[0].id;
 199   address0.transport_name = addr[0].plugin;
 200   address0.address = addr[0].addr;
 201   address0.address_length = addr[0].addr_len;
 202   GNUNET_ATS_address_update (ats, &address0, addr[0].session, NULL, 0);
 203
 204   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Testing ATS info creation\n");
 205
 206   atsi[0].type = htonl (GNUNET_ATS_UTILIZATION_UP);
 207   atsi[0].value = htonl (1024);
 208
 209   GNUNET_ATS_address_update (ats, &address0, addr[0].session, atsi, 1);
 210
 211   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Testing ATS info update\n");
 212
 213   atsi[0].type = htonl (GNUNET_ATS_UTILIZATION_UP);
 214   atsi[0].value = htonl (2048);
 215
 216   atsi[1].type = htonl (GNUNET_ATS_UTILIZATION_DOWN);
 217   atsi[1].value = htonl (1024);
 218
 219   GNUNET_ATS_address_update (ats, &address0, addr[0].session, atsi, 2);
 220
 221   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Testing manual address deletion \n");
 222   address0.peer = p[1].id;      // FIXME: why? typo in old code?
 223   GNUNET_ATS_address_update (ats, &address0, addr[0].session, NULL, 0);
 224   GNUNET_ATS_address_destroyed (ats, &address0, addr[0].session);
 225
 226   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Requesting peer `%s'\n",
 227               GNUNET_i2s (&p[0].id));
 228   GNUNET_ATS_suggest_address (ats, &p[0].id);
 229 }
 230
 231 int
 232 main (int argc, char *argv[])
 233 {
 234   static char *const argv2[] = { "test_ats_api_scheduling",
 235     "-c",
 236     "test_ats_api.conf",
 237     "-L", "WARNING",
 238     NULL
 239   };
 240
 241   static struct GNUNET_GETOPT_CommandLineOption options[] = {
 242     GNUNET_GETOPT_OPTION_END
 243   };
 244
 245   GNUNET_PROGRAM_run ((sizeof (argv2) / sizeof (char *)) - 1, argv2,
 246                       "test_ats_api_scheduling", "nohelp", options, &check,
 247                       NULL);
 248
 249
 250   return ret;
 251 }
 252
 253 /* end of file test_ats_api_scheduling.c */