src/arm/test_exponential_backoff.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 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  * @file arm/test_exponential_backoff.c
  22  * @brief testcase for gnunet-service-arm.c
  23  */
  24 #include "platform.h"
  25 #include "gnunet_arm_service.h"
  26 #include "gnunet_client_lib.h"
  27 #include "gnunet_configuration_lib.h"
  28 #include "gnunet_program_lib.h"
  29 #include "gnunet_protocols.h"
  30
  31 #define VERBOSE GNUNET_NO
  32 #define START_ARM GNUNET_YES
  33 #define LOG_BACKOFF GNUNET_NO
  34 #define TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 10)
  35 #define SERVICE_TEST_TIMEOUT GNUNET_TIME_UNIT_FOREVER_REL
  36 #define FIVE_MILLISECONDS GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS, 5)
  37
  38 static const struct GNUNET_CONFIGURATION_Handle *cfg;
  39 static struct GNUNET_ARM_Handle *arm;
  40 static int ok = 1;
  41
  42 static int trialCount;
  43 static struct GNUNET_TIME_Absolute startedWaitingAt;
  44 struct GNUNET_TIME_Relative waitedFor;
  45
  46 #if LOG_BACKOFF
  47 static FILE *killLogFilePtr;
  48 static char *killLogFileName;
  49 #endif
  50
  51
  52 /**
  53  * Context for handling the shutdown of a service.
  54  */
  55 struct ShutdownContext
  56 {
  57   /**
  58    * Connection to the service that is being shutdown.
  59    */
  60   struct GNUNET_CLIENT_Connection *sock;
  61
  62   /**
  63    * Time allowed for shutdown to happen.
  64    */
  65   struct GNUNET_TIME_Absolute timeout;
  66
  67   /**
  68    * Task set up to cancel the shutdown request on timeout.
  69    */
  70   GNUNET_SCHEDULER_TaskIdentifier cancel_task;
  71
  72   /**
  73    * Task to call once shutdown complete
  74    */
  75   GNUNET_CLIENT_ShutdownTask cont;
  76
  77   /**
  78    * Closure for shutdown continuation
  79    */
  80   void *cont_cls;
  81
  82   /**
  83    * We received a confirmation that the service will shut down.
  84    */
  85   int confirmed;
  86
  87 };
  88
  89 /**
  90  * Handler receiving response to service shutdown requests.
  91  * First call with NULL: service misbehaving, or something.
  92  * First call with GNUNET_MESSAGE_TYPE_ARM_SHUTDOWN_ACK:
  93  *   - service will shutdown
  94  * Second call with NULL:
  95  *   - service has now really shut down.
  96  *
  97  * @param cls closure
  98  * @param msg NULL, indicating socket closure.
  99  */
 100 static void
 101 service_shutdown_handler (void *cls, const struct GNUNET_MessageHeader *msg)
 102 {
 103   struct ShutdownContext *shutdown_ctx = cls;
 104
 105   if ((msg == NULL) && (shutdown_ctx->confirmed != GNUNET_YES))
 106   {
 107     /* Means the other side closed the connection and never confirmed a shutdown */
 108     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 109                 "Service handle shutdown before ACK!\n");
 110     if (shutdown_ctx->cont != NULL)
 111       shutdown_ctx->cont (shutdown_ctx->cont_cls, GNUNET_SYSERR);
 112     GNUNET_SCHEDULER_cancel (shutdown_ctx->cancel_task);
 113     GNUNET_CLIENT_disconnect (shutdown_ctx->sock, GNUNET_NO);
 114     GNUNET_free (shutdown_ctx);
 115   }
 116   else if ((msg == NULL) && (shutdown_ctx->confirmed == GNUNET_YES))
 117   {
 118 #if VERBOSE
 119     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Service shutdown complete.\n");
 120 #endif
 121     if (shutdown_ctx->cont != NULL)
 122       shutdown_ctx->cont (shutdown_ctx->cont_cls, GNUNET_NO);
 123
 124     GNUNET_SCHEDULER_cancel (shutdown_ctx->cancel_task);
 125     GNUNET_CLIENT_disconnect (shutdown_ctx->sock, GNUNET_NO);
 126     GNUNET_free (shutdown_ctx);
 127   }
 128   else
 129   {
 130     GNUNET_assert (ntohs (msg->size) == sizeof (struct GNUNET_MessageHeader));
 131     switch (ntohs (msg->type))
 132     {
 133     case GNUNET_MESSAGE_TYPE_ARM_SHUTDOWN_ACK:
 134 #if VERBOSE
 135       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 136                   "Received confirmation for service shutdown.\n");
 137 #endif
 138       shutdown_ctx->confirmed = GNUNET_YES;
 139       GNUNET_CLIENT_receive (shutdown_ctx->sock,
 140                              &service_shutdown_handler,
 141                              shutdown_ctx, GNUNET_TIME_UNIT_FOREVER_REL);
 142       break;
 143     default:                   /* Fall through */
 144       GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Service shutdown refused!\n");
 145       if (shutdown_ctx->cont != NULL)
 146         shutdown_ctx->cont (shutdown_ctx->cont_cls, GNUNET_YES);
 147
 148       GNUNET_SCHEDULER_cancel (shutdown_ctx->cancel_task);
 149       GNUNET_CLIENT_disconnect (shutdown_ctx->sock, GNUNET_NO);
 150       GNUNET_free (shutdown_ctx);
 151       break;
 152     }
 153   }
 154 }
 155
 156 /**
 157  * Shutting down took too long, cancel receive and return error.
 158  *
 159  * @param cls closure
 160  * @param tc context information (why was this task triggered now)
 161  */
 162 void
 163 service_shutdown_cancel (void *cls,
 164                          const struct GNUNET_SCHEDULER_TaskContext *tc)
 165 {
 166   struct ShutdownContext *shutdown_ctx = cls;
 167
 168   GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "service_shutdown_cancel called!\n");
 169   shutdown_ctx->cont (shutdown_ctx->cont_cls, GNUNET_SYSERR);
 170   GNUNET_CLIENT_disconnect (shutdown_ctx->sock, GNUNET_NO);
 171   GNUNET_free (shutdown_ctx);
 172 }
 173
 174
 175 /**
 176  * If possible, write a shutdown message to the target
 177  * buffer and destroy the client connection.
 178  *
 179  * @param cls the "struct GNUNET_CLIENT_Connection" to destroy
 180  * @param size number of bytes available in buf
 181  * @param buf NULL on error, otherwise target buffer
 182  * @return number of bytes written to buf
 183  */
 184 static size_t
 185 write_shutdown (void *cls, size_t size, void *buf)
 186 {
 187   struct GNUNET_MessageHeader *msg;
 188   struct ShutdownContext *shutdown_ctx = cls;
 189
 190   if (size < sizeof (struct GNUNET_MessageHeader))
 191   {
 192     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 193                 _("Failed to transmit shutdown request to client.\n"));
 194     shutdown_ctx->cont (shutdown_ctx->cont_cls, GNUNET_SYSERR);
 195     GNUNET_CLIENT_disconnect (shutdown_ctx->sock, GNUNET_NO);
 196     GNUNET_free (shutdown_ctx);
 197     return 0;                   /* client disconnected */
 198   }
 199
 200   GNUNET_CLIENT_receive (shutdown_ctx->sock,
 201                          &service_shutdown_handler, shutdown_ctx,
 202                          GNUNET_TIME_UNIT_FOREVER_REL);
 203   shutdown_ctx->cancel_task =
 204       GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_absolute_get_remaining
 205                                     (shutdown_ctx->timeout),
 206                                     &service_shutdown_cancel, shutdown_ctx);
 207   msg = (struct GNUNET_MessageHeader *) buf;
 208   msg->type = htons (GNUNET_MESSAGE_TYPE_ARM_SHUTDOWN);
 209   msg->size = htons (sizeof (struct GNUNET_MessageHeader));
 210   return sizeof (struct GNUNET_MessageHeader);
 211 }
 212
 213
 214 /**
 215  * Request that the service should shutdown.
 216  * Afterwards, the connection will automatically be
 217  * disconnected.  Hence the "sock" should not
 218  * be used by the caller after this call
 219  * (calling this function frees "sock" after a while).
 220  *
 221  * @param sock the socket connected to the service
 222  * @param timeout how long to wait before giving up on transmission
 223  * @param cont continuation to call once the service is really down
 224  * @param cont_cls closure for continuation
 225  *
 226  */
 227 static void
 228 arm_service_shutdown (struct GNUNET_CLIENT_Connection *sock,
 229                       struct GNUNET_TIME_Relative timeout,
 230                       GNUNET_CLIENT_ShutdownTask cont, void *cont_cls)
 231 {
 232   struct ShutdownContext *shutdown_ctx;
 233
 234   shutdown_ctx = GNUNET_malloc (sizeof (struct ShutdownContext));
 235   shutdown_ctx->cont = cont;
 236   shutdown_ctx->cont_cls = cont_cls;
 237   shutdown_ctx->sock = sock;
 238   shutdown_ctx->timeout = GNUNET_TIME_relative_to_absolute (timeout);
 239   GNUNET_CLIENT_notify_transmit_ready (sock,
 240                                        sizeof (struct
 241                                                GNUNET_MessageHeader),
 242                                        timeout,
 243                                        GNUNET_NO,
 244                                        &write_shutdown, shutdown_ctx);
 245 }
 246
 247
 248 static void
 249 arm_notify_stop (void *cls, int success)
 250 {
 251   GNUNET_assert (success == GNUNET_NO);
 252 #if START_ARM
 253   GNUNET_ARM_stop_service (arm, "arm", TIMEOUT, NULL, NULL);
 254 #endif
 255 }
 256
 257
 258 static void
 259 kill_task (void *cbData, const struct GNUNET_SCHEDULER_TaskContext *tc);
 260
 261
 262 static void
 263 do_nothing_notify (void *cls, int success)
 264 {
 265   GNUNET_assert (success == GNUNET_YES);
 266   ok = 1;
 267   GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS, &kill_task, NULL);
 268 }
 269
 270
 271 static void
 272 arm_notify (void *cls, int success)
 273 {
 274   GNUNET_assert (success == GNUNET_YES);
 275   GNUNET_ARM_start_service (arm,
 276                             "do-nothing", TIMEOUT, &do_nothing_notify, NULL);
 277 }
 278
 279
 280 static void
 281 kill_task (void *cbData, const struct GNUNET_SCHEDULER_TaskContext *tc);
 282
 283
 284 static void
 285 do_nothing_restarted_notify_task (void *cls,
 286                                   const struct GNUNET_SCHEDULER_TaskContext *tc)
 287 {
 288   static char a;
 289
 290   trialCount++;
 291
 292 #if LOG_BACKOFF
 293   if ((tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN) != 0)
 294   {
 295     fprintf (killLogFilePtr, "%d.Reason is shutdown!\n", trialCount);
 296   }
 297   else if ((tc->reason & GNUNET_SCHEDULER_REASON_TIMEOUT) != 0)
 298   {
 299     fprintf (killLogFilePtr, "%d.Reason is timeout!\n", trialCount);
 300   }
 301   else if ((tc->reason & GNUNET_SCHEDULER_REASON_PREREQ_DONE) != 0)
 302   {
 303     fprintf (killLogFilePtr, "%d.Service is running!\n", trialCount);
 304   }
 305 #endif
 306   GNUNET_SCHEDULER_add_now (&kill_task, &a);
 307 }
 308
 309
 310 static void
 311 do_test (void *cbData, const struct GNUNET_SCHEDULER_TaskContext *tc)
 312 {
 313   GNUNET_CLIENT_service_test ("do-nothing",
 314                               cfg, TIMEOUT,
 315                               &do_nothing_restarted_notify_task, NULL);
 316 }
 317
 318
 319 static void
 320 shutdown_cont (void *cls, int reason)
 321 {
 322   trialCount++;
 323   startedWaitingAt = GNUNET_TIME_absolute_get ();
 324   GNUNET_SCHEDULER_add_delayed (waitedFor, &do_test, NULL);
 325 }
 326
 327
 328 static void
 329 kill_task (void *cbData, const struct GNUNET_SCHEDULER_TaskContext *tc)
 330 {
 331   static struct GNUNET_CLIENT_Connection *doNothingConnection = NULL;
 332
 333   if (NULL != cbData)
 334   {
 335     waitedFor = GNUNET_TIME_absolute_get_duration (startedWaitingAt);
 336
 337 #if LOG_BACKOFF
 338     fprintf (killLogFilePtr,
 339              "Waited for: %llu ms\n", (unsigned long long) waitedFor.rel_value);
 340 #endif
 341   }
 342   else
 343   {
 344     waitedFor.rel_value = 0;
 345   }
 346   /* Connect to the doNothing task */
 347   doNothingConnection = GNUNET_CLIENT_connect ("do-nothing", cfg);
 348   GNUNET_assert (doNothingConnection != NULL);
 349   if (trialCount == 12)
 350   {
 351     GNUNET_CLIENT_disconnect (doNothingConnection, GNUNET_NO);
 352     GNUNET_ARM_stop_service (arm,
 353                              "do-nothing", TIMEOUT, &arm_notify_stop, NULL);
 354     ok = 0;
 355     return;
 356   }
 357   /* Use the created connection to kill the doNothingTask */
 358   arm_service_shutdown (doNothingConnection, TIMEOUT, &shutdown_cont, NULL);
 359 }
 360
 361
 362 static void
 363 task (void *cls,
 364       char *const *args,
 365       const char *cfgfile, const struct GNUNET_CONFIGURATION_Handle *c)
 366 {
 367   cfg = c;
 368
 369   arm = GNUNET_ARM_connect (cfg, NULL);
 370 #if START_ARM
 371   GNUNET_ARM_start_service (arm, "arm", GNUNET_TIME_UNIT_ZERO, &arm_notify,
 372                             NULL);
 373 #else
 374   arm_do_nothing (NULL, GNUNET_YES);
 375 #endif
 376 }
 377
 378 static int
 379 check ()
 380 {
 381   char *const argv[] = {
 382     "test-arm-api",
 383     "-c", "test_arm_api_data.conf",
 384 #if VERBOSE
 385     "-L", "DEBUG",
 386 #endif
 387     NULL
 388   };
 389   struct GNUNET_GETOPT_CommandLineOption options[] = {
 390     GNUNET_GETOPT_OPTION_END
 391   };
 392
 393   /* Running ARM  and running the do_nothing task */
 394   GNUNET_assert (GNUNET_OK ==
 395                  GNUNET_PROGRAM_run ((sizeof (argv) / sizeof (char *)) - 1,
 396                                      argv,
 397                                      "test-exponential-backoff",
 398                                      "nohelp", options, &task, NULL));
 399
 400
 401   return ok;
 402 }
 403
 404 static int
 405 init ()
 406 {
 407 #if LOG_BACKOFF
 408   killLogFileName = GNUNET_DISK_mktemp ("exponential-backoff-waiting.log");
 409   if (NULL == (killLogFilePtr = FOPEN (killLogFileName, "w")))
 410   {
 411     GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "fopen",
 412                               killLogFileName);
 413     GNUNET_free (killLogFileName);
 414     return GNUNET_SYSERR;
 415   }
 416 #endif
 417   return GNUNET_OK;
 418 }
 419
 420
 421 static void
 422 houseKeep ()
 423 {
 424 #if LOG_BACKOFF
 425   GNUNET_assert (0 == fclose (killLogFilePtr));
 426   GNUNET_free (killLogFileName);
 427 #endif
 428 }
 429
 430
 431 int
 432 main (int argc, char *argv[])
 433 {
 434   int ret;
 435
 436   GNUNET_log_setup ("test-exponential-backoff",
 437 #if VERBOSE
 438                     "DEBUG",
 439 #else
 440                     "WARNING",
 441 #endif
 442                     NULL);
 443
 444   init ();
 445   ret = check ();
 446   houseKeep ();
 447   return ret;
 448 }
 449
 450 /* end of test_exponential_backoff.c */