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 VERBOSE GNUNET_EXTRA_LOGGING
  38
  39 #define VERBOSE_ARM GNUNET_EXTRA_LOGGING
  40
  41 #define TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 10)
  42
  43 static GNUNET_SCHEDULER_TaskIdentifier die_task;
  44
  45 static struct GNUNET_ATS_SchedulingHandle *ats;
  46
  47 struct GNUNET_OS_Process * arm_proc;
  48
  49
  50
  51 static int ret;
  52
  53 struct Address
  54 {
  55   char * plugin;
  56   size_t plugin_len;
  57
  58   void * addr;
  59   size_t addr_len;
  60
  61   struct GNUNET_ATS_Information * ats;
  62   int ats_count;
  63
  64   void  *session;
  65 };
  66
  67 struct PeerContext
  68 {
  69   struct GNUNET_PeerIdentity id;
  70
  71   struct Address * addr;
  72 };
  73
  74 struct Address addr[2];
  75 struct PeerContext p[2];
  76 struct GNUNET_ATS_Information atsi[2];
  77
  78 static void
  79 stop_arm ()
  80 {
  81   if (0 != GNUNET_OS_process_kill (arm_proc, SIGTERM))
  82     GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "kill");
  83   GNUNET_OS_process_wait (arm_proc);
  84   GNUNET_OS_process_close (arm_proc);
  85   arm_proc = NULL;
  86 }
  87
  88
  89 static void
  90 end_badly (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
  91 {
  92   die_task = GNUNET_SCHEDULER_NO_TASK;
  93   if (ats != NULL)
  94     GNUNET_ATS_scheduling_done (ats);
  95
  96   ret = GNUNET_SYSERR;
  97
  98   stop_arm ();
  99 }
 100
 101
 102 static void
 103 end ()
 104 {
 105   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Shutting down\n");
 106   if (die_task != GNUNET_SCHEDULER_NO_TASK)
 107   {
 108     GNUNET_SCHEDULER_cancel(die_task);
 109     die_task = GNUNET_SCHEDULER_NO_TASK;
 110   }
 111
 112   GNUNET_ATS_scheduling_done (ats);
 113
 114   ret = 0;
 115
 116   stop_arm ();
 117 }
 118
 119
 120 static void
 121 address_suggest_cb (void *cls,
 122                     const struct
 123                     GNUNET_PeerIdentity *
 124                     peer,
 125                     const char *plugin_name,
 126                     const void *plugin_addr,
 127                     size_t plugin_addr_len,
 128                     struct Session * session,
 129                     struct
 130                     GNUNET_BANDWIDTH_Value32NBO
 131                     bandwidth_out,
 132                     struct
 133                     GNUNET_BANDWIDTH_Value32NBO
 134                     bandwidth_in,
 135                     const struct
 136                     GNUNET_ATS_Information
 137                     * ats,
 138                     uint32_t ats_count)
 139
 140 {
 141   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "ATS suggests address `%s'\n", GNUNET_i2s (peer));
 142
 143   GNUNET_assert (0 == memcmp (peer, &p[0].id, sizeof (struct GNUNET_PeerIdentity)));
 144   GNUNET_assert (0 == strcmp (plugin_name, addr[0].plugin));
 145   GNUNET_assert (plugin_addr_len == addr[0].addr_len);
 146   GNUNET_assert (0 == memcmp (plugin_addr, addr[0].plugin, plugin_addr_len));
 147   GNUNET_assert (addr[0].session == session);
 148
 149
 150   /* TODO ats merge
 151   GNUNET_assert (ats_count == 2);
 152   GNUNET_assert (atsi[0].type == htons (1));
 153   GNUNET_assert (atsi[0].type == htons (2));
 154   GNUNET_assert (atsi[1].type == htons (2));
 155   GNUNET_assert (atsi[1].type == htons (2));
 156   */
 157
 158   ret = 0;
 159
 160   GNUNET_SCHEDULER_add_now(&end, NULL);
 161 }
 162
 163 void
 164 start_arm (const char *cfgname)
 165 {
 166   arm_proc = GNUNET_OS_start_process (NULL, NULL, "gnunet-service-arm",
 167                            "gnunet-service-arm",
 168 #if VERBOSE_ARM
 169                            "-L", "DEBUG",
 170 #endif
 171                            "-c", cfgname, NULL);
 172 }
 173
 174 static void
 175 check (void *cls, char *const *args, const char *cfgfile,
 176        const struct GNUNET_CONFIGURATION_Handle *cfg)
 177 {
 178   ret = GNUNET_SYSERR;
 179
 180   die_task = GNUNET_SCHEDULER_add_delayed(TIMEOUT, &end_badly, NULL);
 181   start_arm (cfgfile);
 182
 183   ats = GNUNET_ATS_scheduling_init (cfg, &address_suggest_cb, NULL);
 184
 185   if (ats == NULL)
 186   {
 187     ret = GNUNET_SYSERR;
 188     end ();
 189     return;
 190   }
 191
 192   /* set up peer */
 193   GNUNET_CRYPTO_hash_create_random(GNUNET_CRYPTO_QUALITY_WEAK, &p[0].id.hashPubKey);
 194   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Created peer `%s'\n", GNUNET_i2s (&p[0].id));
 195
 196   GNUNET_CRYPTO_hash_create_random(GNUNET_CRYPTO_QUALITY_WEAK, &p[1].id.hashPubKey);
 197   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Created peer `%s'\n", GNUNET_i2s (&p[1].id));
 198
 199   addr[0].plugin = "test";
 200   addr[0].session = NULL;
 201   addr[0].addr = strdup("test");
 202   addr[0].addr_len = 4;
 203
 204   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Testing address creation\n");
 205
 206   GNUNET_ATS_address_update(ats, &p[0].id, addr[0].plugin, addr[0].addr, addr[0].addr_len, addr[0].session, NULL, 0);
 207
 208   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Testing ATS info creation\n");
 209
 210   atsi[0].type = htons (1);
 211   atsi[0].type = htons (1);
 212
 213   GNUNET_ATS_address_update(ats, &p[0].id, addr[0].plugin, addr[0].addr, addr[0].addr_len, addr[0].session, atsi, 1);
 214
 215   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Testing ATS info merging\n");
 216
 217   atsi[0].type = htons (1);
 218   atsi[0].type = htons (2);
 219
 220   atsi[1].type = htons (2);
 221   atsi[1].type = htons (2);
 222
 223   GNUNET_ATS_address_update(ats, &p[0].id, addr[0].plugin, addr[0].addr, addr[0].addr_len, addr[0].session, atsi, 2);
 224
 225   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Testing manual address deletion \n");
 226   GNUNET_ATS_address_update(ats, &p[1].id, addr[0].plugin, addr[0].addr, addr[0].addr_len, addr[0].session, NULL, 0);
 227   GNUNET_ATS_address_destroyed (ats, &p[1].id, addr[0].plugin, addr[0].addr, addr[0].addr_len, addr[0].session );
 228
 229   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Requesting peer `%s'\n", GNUNET_i2s (&p[0].id));
 230   GNUNET_ATS_suggest_address(ats, &p[0].id);
 231 }
 232
 233 int
 234 main (int argc, char *argv[])
 235 {
 236   static char *const argv2[] = { "test_ats_api_scheduling",
 237     "-c",
 238     "test_ats_api.conf",
 239 #if VERBOSE
 240     "-L", "DEBUG",
 241 #else
 242     "-L", "WARNING",
 243 #endif
 244     NULL
 245   };
 246
 247   static struct GNUNET_GETOPT_CommandLineOption options[] = {
 248     GNUNET_GETOPT_OPTION_END
 249   };
 250
 251   GNUNET_PROGRAM_run ((sizeof (argv2) / sizeof (char *)) - 1, argv2,
 252                       "test_ats_api_scheduling", "nohelp", options, &check,
 253                       NULL);
 254
 255
 256   return ret;
 257 }
 258
 259 /* end of file test_ats_api_scheduling.c */