src/arm/arm_api.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2009, 2010, 2012, 2013 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 arm/arm_api.c
  23  * @brief API for accessing the ARM service
  24  * @author Christian Grothoff
  25  * @author LRN
  26  */
  27 #include "platform.h"
  28 #include "gnunet_util_lib.h"
  29 #include "gnunet_arm_service.h"
  30 #include "gnunet_protocols.h"
  31 #include "arm.h"
  32
  33 #define LOG(kind,...) GNUNET_log_from (kind, "arm-api",__VA_ARGS__)
  34
  35 /**
  36  * Handle for interacting with ARM.
  37  */
  38 struct GNUNET_ARM_Handle
  39 {
  40   /**
  41    * Our control connection to the ARM service.
  42    */
  43   struct GNUNET_CLIENT_Connection *client;
  44
  45   /**
  46    * The configuration that we are using.
  47    */
  48   struct GNUNET_CONFIGURATION_Handle *cfg;
  49
  50   /**
  51    * Handle for our current transmission request.
  52    */
  53   struct GNUNET_CLIENT_TransmitHandle *cth;
  54
  55   /**
  56    * Head of doubly-linked list of pending requests.
  57    */
  58   struct ARMControlMessage *control_pending_head;
  59
  60   /**
  61    * Tail of doubly-linked list of pending requests.
  62    */
  63   struct ARMControlMessage *control_pending_tail;
  64
  65   /**
  66    * Head of doubly-linked list of sent requests.
  67    */
  68   struct ARMControlMessage *control_sent_head;
  69
  70   /**
  71    * Tail of doubly-linked list of sent requests.
  72    */
  73   struct ARMControlMessage *control_sent_tail;
  74
  75   /**
  76    * Callback to invoke on connection/disconnection.
  77    */
  78   GNUNET_ARM_ConnectionStatusCallback conn_status;
  79
  80   /**
  81    * Closure for conn_status.
  82    */
  83   void *conn_status_cls;
  84
  85   /**
  86    * ARM control message for the 'arm_termination_handler'
  87    * with the continuation to call once the ARM shutdown is done.
  88    */
  89   struct ARMControlMessage *thm;
  90
  91   /**
  92    * ID of the reconnect task (if any).
  93    */
  94   GNUNET_SCHEDULER_TaskIdentifier reconnect_task;
  95
  96   /**
  97    * Current delay we use for re-trying to connect to core.
  98    */
  99   struct GNUNET_TIME_Relative retry_backoff;
 100
 101   /**
 102    * Counter for request identifiers
 103    */
 104   uint64_t request_id_counter;
 105
 106   /**
 107    * Are we currently disconnected and hence unable to send?
 108    */
 109   unsigned char currently_down;
 110
 111   /**
 112    * GNUNET_YES if we're running a service test.
 113    */
 114   unsigned char service_test_is_active;
 115 };
 116
 117
 118 /**
 119  * Entry in a doubly-linked list of control messages to be transmitted
 120  * to the arm service.
 121  *
 122  * The actual message is allocated at the end of this struct.
 123  */
 124 struct ARMControlMessage
 125 {
 126   /**
 127    * This is a doubly-linked list.
 128    */
 129   struct ARMControlMessage *next;
 130
 131   /**
 132    * This is a doubly-linked list.
 133    */
 134   struct ARMControlMessage *prev;
 135
 136   /**
 137    * ARM handle.
 138    */
 139   struct GNUNET_ARM_Handle *h;
 140
 141   /**
 142    * Message to send.
 143    */
 144   struct GNUNET_ARM_Message *msg;
 145
 146   /**
 147    * Callback for service state change requests.
 148    */
 149   GNUNET_ARM_ResultCallback result_cont;
 150
 151   /**
 152    * Callback for service list requests.
 153    */
 154   GNUNET_ARM_ServiceListCallback list_cont;
 155
 156   /**
 157    * Closure for 'result_cont' or 'list_cont'.
 158    */
 159   void *cont_cls;
 160
 161   /**
 162    * Timeout for the operation.
 163    */
 164   struct GNUNET_TIME_Absolute timeout;
 165
 166   /**
 167    * Task to run when request times out.
 168    */
 169   GNUNET_SCHEDULER_TaskIdentifier timeout_task_id;
 170
 171   /**
 172    * Flags for passing std descriptors to ARM (when starting ARM).
 173    */
 174   enum GNUNET_OS_InheritStdioFlags std_inheritance;
 175
 176   /**
 177    * Type of the request expressed as a message type (start, stop or list).
 178    */
 179   uint16_t type;
 180 };
 181
 182
 183 /**
 184  * Connect to arm.
 185  *
 186  * @param h arm handle
 187  * @return GNUNET_OK on success, GNUNET_SYSERR on failure
 188  */
 189 static int
 190 reconnect_arm (struct GNUNET_ARM_Handle *h);
 191
 192
 193 /**
 194  * Check the list of pending requests, send the next
 195  * one to the arm.
 196  *
 197  * @param h arm handle
 198  * @param ignore_currently_down transmit message even if not initialized?
 199  */
 200 static void
 201 trigger_next_request (struct GNUNET_ARM_Handle *h, int ignore_currently_down);
 202
 203
 204 /**
 205  * Task scheduled to try to re-connect to arm.
 206  *
 207  * @param cls the 'struct GNUNET_ARM_Handle'
 208  * @param tc task context
 209  */
 210 static void
 211 reconnect_arm_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 212 {
 213   struct GNUNET_ARM_Handle *h = cls;
 214
 215   h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
 216   LOG (GNUNET_ERROR_TYPE_DEBUG, "Connecting to ARM service after delay\n");
 217   reconnect_arm (h);
 218 }
 219
 220
 221 /**
 222  * Close down any existing connection to the ARM service and
 223  * try re-establishing it later.
 224  *
 225  * @param h our handle
 226  */
 227 static void
 228 reconnect_arm_later (struct GNUNET_ARM_Handle *h)
 229 {
 230   if (GNUNET_NO != h->currently_down)
 231     return;
 232   if (NULL != h->cth)
 233   {
 234     GNUNET_CLIENT_notify_transmit_ready_cancel (h->cth);
 235     h->cth = NULL;
 236   }
 237   if (NULL != h->client)
 238   {
 239     GNUNET_CLIENT_disconnect (h->client);
 240     h->client = NULL;
 241   }
 242   h->currently_down = GNUNET_YES;
 243   GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == h->reconnect_task);
 244   h->reconnect_task =
 245       GNUNET_SCHEDULER_add_delayed (h->retry_backoff, &reconnect_arm_task, h);
 246   /* Don't clear pending messages on disconnection, deliver them later
 247   clear_pending_messages (h, GNUNET_ARM_REQUEST_DISCONNECTED);
 248   GNUNET_assert (NULL == h->control_pending_head);
 249   */
 250   h->retry_backoff = GNUNET_TIME_STD_BACKOFF (h->retry_backoff);
 251   if (NULL != h->conn_status)
 252     h->conn_status (h->conn_status_cls, GNUNET_NO);
 253 }
 254
 255
 256 /**
 257  * Find a control message by its unique ID.
 258  *
 259  * @param h ARM handle
 260  * @param id unique message ID to use for the lookup
 261  * @return NULL if not found
 262  */
 263 static struct ARMControlMessage *
 264 find_cm_by_id (struct GNUNET_ARM_Handle *h, uint64_t id)
 265 {
 266   struct ARMControlMessage *result;
 267   for (result = h->control_sent_head; result; result = result->next)
 268     if (id == result->msg->request_id)
 269       return result;
 270   return NULL;
 271 }
 272
 273
 274 /**
 275  * Handler for ARM 'termination' reply (failure to receive).
 276  *
 277  * @param cls our "struct GNUNET_ARM_Handle"
 278  * @param msg expected to be NULL
 279  */
 280 static void
 281 arm_termination_handler (void *cls, const struct GNUNET_MessageHeader *msg)
 282 {
 283   struct GNUNET_ARM_Handle *h = cls;
 284   struct ARMControlMessage *cm;
 285
 286   if (NULL != msg)
 287   {
 288     GNUNET_break (0);
 289     GNUNET_CLIENT_receive (h->client, &arm_termination_handler, h,
 290                            GNUNET_TIME_UNIT_FOREVER_REL);
 291     return;
 292   }
 293   cm = h->thm;
 294   h->thm = NULL;
 295   h->currently_down = GNUNET_YES;
 296   GNUNET_CLIENT_disconnect (h->client);
 297   h->client = NULL;
 298   if (NULL != cm->result_cont)
 299     cm->result_cont (cm->cont_cls,
 300                      GNUNET_ARM_REQUEST_SENT_OK,
 301                      (const char *) &cm->msg[1],
 302                      GNUNET_ARM_RESULT_STOPPED);
 303   GNUNET_free (cm->msg);
 304   GNUNET_free (cm);
 305 }
 306
 307
 308 /**
 309  * Handler for ARM replies.
 310  *
 311  * @param cls our `struct GNUNET_ARM_Handle`
 312  * @param msg the message received from the arm service
 313  */
 314 static void
 315 client_notify_handler (void *cls,
 316                        const struct GNUNET_MessageHeader *msg)
 317 {
 318   struct GNUNET_ARM_Handle *h = cls;
 319   const struct GNUNET_ARM_Message *arm_msg;
 320   const struct GNUNET_ARM_ResultMessage *res;
 321   const struct GNUNET_ARM_ListResultMessage *lres;
 322   struct ARMControlMessage *cm;
 323   const char **list;
 324   const char *pos;
 325   uint64_t id;
 326   enum GNUNET_ARM_Result result;
 327   uint16_t size_check;
 328   uint16_t rcount;
 329   uint16_t msize;
 330   unsigned char fail;
 331
 332   list = NULL;
 333   rcount = 0;
 334   if (NULL == msg)
 335   {
 336     LOG (GNUNET_ERROR_TYPE_INFO,
 337          _("Client was disconnected from arm service, trying to reconnect.\n"));
 338     reconnect_arm_later (h);
 339     return;
 340   }
 341   msize = ntohs (msg->size);
 342   LOG (GNUNET_ERROR_TYPE_DEBUG,
 343        "Processing message of type %u and size %u from arm service\n",
 344        ntohs (msg->type), msize);
 345   if (msize < sizeof (struct GNUNET_ARM_Message))
 346   {
 347     GNUNET_break (0);
 348     reconnect_arm_later (h);
 349     return;
 350   }
 351   arm_msg = (const struct GNUNET_ARM_Message *) msg;
 352   GNUNET_break (0 == ntohl (arm_msg->reserved));
 353   id = GNUNET_ntohll (arm_msg->request_id);
 354   cm = find_cm_by_id (h, id);
 355   if (NULL == cm)
 356   {
 357     LOG (GNUNET_ERROR_TYPE_DEBUG,
 358          "Message with unknown id %llu\n",
 359          id);
 360     return;
 361   }
 362   fail = GNUNET_NO;
 363   switch (ntohs (msg->type))
 364   {
 365   case GNUNET_MESSAGE_TYPE_ARM_RESULT:
 366     if (msize < sizeof (struct GNUNET_ARM_ResultMessage))
 367     {
 368       GNUNET_assert (0);
 369       fail = GNUNET_YES;
 370     }
 371     break;
 372   case GNUNET_MESSAGE_TYPE_ARM_LIST_RESULT:
 373     if (msize < sizeof (struct GNUNET_ARM_ListResultMessage))
 374     {
 375       GNUNET_break (0);
 376       fail = GNUNET_YES;
 377       break;
 378     }
 379     size_check = 0;
 380     lres = (const struct GNUNET_ARM_ListResultMessage *) msg;
 381     rcount = ntohs (lres->count);
 382     {
 383       unsigned int i;
 384
 385       list = GNUNET_malloc (sizeof (const char *) * rcount);
 386       pos = (const char *)&lres[1];
 387       for (i = 0; i < rcount; i++)
 388       {
 389         const char *end = memchr (pos, 0, msize - size_check);
 390         if (NULL == end)
 391         {
 392           GNUNET_break (0);
 393           fail = GNUNET_YES;
 394           break;
 395         }
 396         list[i] = pos;
 397         size_check += (end - pos) + 1;
 398         pos = end + 1;
 399       }
 400       if (GNUNET_YES == fail)
 401       {
 402         GNUNET_free (list);
 403         list = NULL;
 404       }
 405     }
 406     break;
 407   default:
 408     fail = GNUNET_YES;
 409     break;
 410   }
 411   GNUNET_assert (GNUNET_SCHEDULER_NO_TASK != cm->timeout_task_id);
 412   GNUNET_SCHEDULER_cancel (cm->timeout_task_id);
 413   GNUNET_CONTAINER_DLL_remove (h->control_sent_head,
 414                                h->control_sent_tail, cm);
 415   if (GNUNET_YES == fail)
 416   {
 417     reconnect_arm_later (h);
 418     GNUNET_free (cm->msg);
 419     GNUNET_free (cm);
 420     return;
 421   }
 422   if ( (GNUNET_MESSAGE_TYPE_ARM_RESULT == ntohs (msg->type)) &&
 423        (0 == strcasecmp ((const char *) &cm->msg[1],
 424                          "arm")) &&
 425        (NULL != (res = (const struct GNUNET_ARM_ResultMessage *) msg)) &&
 426        (GNUNET_ARM_RESULT_STOPPING == ntohl (res->result)) )
 427   {
 428     /* special case: if we are stopping 'gnunet-service-arm', we do not just
 429        wait for the result message, but also wait for the service to close
 430        the connection (and then we have to close our client handle as well);
 431        this is done by installing a different receive handler, waiting for
 432        the connection to go down */
 433     if (NULL != h->thm)
 434     {
 435       GNUNET_break (0);
 436       cm->result_cont (h->thm->cont_cls,
 437                        GNUNET_ARM_REQUEST_SENT_OK,
 438                        (const char *) &h->thm->msg[1],
 439                        GNUNET_ARM_RESULT_IS_NOT_KNOWN);
 440       GNUNET_free (h->thm->msg);
 441       GNUNET_free (h->thm);
 442     }
 443     h->thm = cm;
 444     GNUNET_CLIENT_receive (h->client, &arm_termination_handler, h,
 445                            GNUNET_TIME_UNIT_FOREVER_REL);
 446     return;
 447   }
 448   GNUNET_CLIENT_receive (h->client, &client_notify_handler, h,
 449                          GNUNET_TIME_UNIT_FOREVER_REL);
 450   switch (ntohs (msg->type))
 451   {
 452   case GNUNET_MESSAGE_TYPE_ARM_RESULT:
 453     res = (const struct GNUNET_ARM_ResultMessage *) msg;
 454     LOG (GNUNET_ERROR_TYPE_DEBUG,
 455          "Received response from ARM for service `%s': %u\n",
 456          (const char *) &cm->msg[1], ntohs (msg->type));
 457     result = (enum GNUNET_ARM_Result) ntohl (res->result);
 458     if (NULL != cm->result_cont)
 459       cm->result_cont (cm->cont_cls, GNUNET_ARM_REQUEST_SENT_OK,
 460                        (const char *) &cm->msg[1], result);
 461     break;
 462   case GNUNET_MESSAGE_TYPE_ARM_LIST_RESULT:
 463     if (NULL != cm->list_cont)
 464         cm->list_cont (cm->cont_cls, GNUNET_ARM_REQUEST_SENT_OK, rcount,
 465                        list);
 466     GNUNET_free_non_null (list);
 467     break;
 468   }
 469   GNUNET_free (cm->msg);
 470   GNUNET_free (cm);
 471 }
 472
 473
 474 /**
 475  * Transmit the next message to the arm service.
 476  *
 477  * @param cls closure with the 'struct GNUNET_ARM_Handle'
 478  * @param size number of bytes available in buf
 479  * @param buf where the callee should write the message
 480  * @return number of bytes written to buf
 481  */
 482 static size_t
 483 transmit_arm_message (void *cls, size_t size, void *buf)
 484 {
 485   struct GNUNET_ARM_Handle *h = cls;
 486   struct ARMControlMessage *cm;
 487   struct GNUNET_ARM_Message *arm_msg;
 488   uint64_t request_id;
 489   int notify_connection;
 490   uint16_t msize;
 491
 492   notify_connection = GNUNET_NO;
 493   LOG (GNUNET_ERROR_TYPE_DEBUG,
 494       "transmit_arm_message is running with %p buffer of size %lu. ARM is known to be %s\n",
 495       buf, size, h->currently_down ? "unconnected" : "connected");
 496   GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == h->reconnect_task);
 497   h->cth = NULL;
 498   if ((GNUNET_YES == h->currently_down) && (NULL != buf))
 499   {
 500     h->currently_down = GNUNET_NO;
 501     notify_connection = GNUNET_YES;
 502     h->retry_backoff = GNUNET_TIME_UNIT_MILLISECONDS;
 503     GNUNET_CLIENT_receive (h->client, &client_notify_handler, h,
 504                            GNUNET_TIME_UNIT_FOREVER_REL);
 505   }
 506   if (NULL == buf)
 507   {
 508     LOG (GNUNET_ERROR_TYPE_DEBUG,
 509          "Transmission failed, initiating reconnect\n");
 510     reconnect_arm_later (h);
 511     return 0;
 512   }
 513   if (NULL == (cm = h->control_pending_head))
 514   {
 515     LOG (GNUNET_ERROR_TYPE_DEBUG, "Queue is empty, not sending anything\n");
 516     msize = 0;
 517     goto end;
 518   }
 519   GNUNET_assert (NULL != cm->msg);
 520   msize = ntohs (cm->msg->header.size);
 521   if (size < msize)
 522   {
 523     LOG (GNUNET_ERROR_TYPE_DEBUG,
 524         "Request is too big (%u < %u), not sending it\n", size, msize);
 525     trigger_next_request (h, GNUNET_NO);
 526     msize = 0;
 527     goto end;
 528   }
 529   arm_msg = cm->msg;
 530   if (0 == h->request_id_counter)
 531     h->request_id_counter++;
 532   request_id = h->request_id_counter++;
 533   LOG (GNUNET_ERROR_TYPE_DEBUG,
 534        "Transmitting control message with %u bytes of type %u to arm with id %llu\n",
 535        (unsigned int) msize, (unsigned int) ntohs (cm->msg->header.type), request_id);
 536   arm_msg->reserved = htonl (0);
 537   arm_msg->request_id = GNUNET_htonll (request_id);
 538   memcpy (buf, cm->msg, msize);
 539   /* Otherwise we won't be able to find it later! */
 540   arm_msg->request_id = request_id;
 541   GNUNET_CONTAINER_DLL_remove (h->control_pending_head,
 542                                h->control_pending_tail, cm);
 543   GNUNET_CONTAINER_DLL_insert_tail (h->control_sent_head,
 544                                     h->control_sent_tail, cm);
 545   /* Don't free msg, keep it around (kind of wasteful, but then we don't
 546    * really have many messages to handle, and it'll be freed when it times
 547    * out anyway.
 548    */
 549   trigger_next_request (h, GNUNET_NO);
 550
 551  end:
 552   if ((GNUNET_YES == notify_connection) && (NULL != h->conn_status))
 553     h->conn_status (h->conn_status_cls, GNUNET_YES);
 554   return msize;
 555 }
 556
 557
 558 /**
 559  * Check the list of pending requests, send the next
 560  * one to the arm.
 561  *
 562  * @param h arm handle
 563  * @param ignore_currently_down transmit message even if not initialized?
 564  */
 565 static void
 566 trigger_next_request (struct GNUNET_ARM_Handle *h, int ignore_currently_down)
 567 {
 568   uint16_t msize;
 569
 570   msize = sizeof (struct GNUNET_MessageHeader);
 571   if ((GNUNET_YES == h->currently_down) && (ignore_currently_down == GNUNET_NO))
 572   {
 573     LOG (GNUNET_ERROR_TYPE_DEBUG,
 574          "ARM connection down, not processing queue\n");
 575     return;
 576   }
 577   if (NULL != h->cth)
 578   {
 579     LOG (GNUNET_ERROR_TYPE_DEBUG, "Request pending, not processing queue\n");
 580     return;
 581   }
 582   if (NULL != h->control_pending_head)
 583     msize =
 584         ntohs (h->control_pending_head->msg->header.size);
 585   else if (GNUNET_NO == ignore_currently_down)
 586   {
 587     LOG (GNUNET_ERROR_TYPE_DEBUG,
 588          "Request queue empty, not processing queue\n");
 589     return;                     /* no pending message */
 590   }
 591   h->cth =
 592       GNUNET_CLIENT_notify_transmit_ready (h->client, msize,
 593                                            GNUNET_TIME_UNIT_FOREVER_REL,
 594                                            GNUNET_NO, &transmit_arm_message, h);
 595 }
 596
 597
 598 /**
 599  * Connect to arm.
 600  *
 601  * @param h arm handle
 602  * @return GNUNET_OK on success, GNUNET_SYSERR on failure
 603  */
 604 static int
 605 reconnect_arm (struct GNUNET_ARM_Handle *h)
 606 {
 607   GNUNET_assert (NULL == h->client);
 608   GNUNET_assert (GNUNET_YES == h->currently_down);
 609   h->client = GNUNET_CLIENT_connect ("arm", h->cfg);
 610   if (NULL == h->client)
 611   {
 612     LOG (GNUNET_ERROR_TYPE_DEBUG,
 613            "arm_api, GNUNET_CLIENT_connect returned NULL\n");
 614     if (NULL != h->conn_status)
 615       h->conn_status (h->conn_status_cls, GNUNET_SYSERR);
 616     return GNUNET_SYSERR;
 617   }
 618   LOG (GNUNET_ERROR_TYPE_DEBUG,
 619          "arm_api, GNUNET_CLIENT_connect returned non-NULL\n");
 620   trigger_next_request (h, GNUNET_YES);
 621   return GNUNET_OK;
 622 }
 623
 624
 625 /**
 626  * Set up a context for communicating with ARM, then
 627  * start connecting to the ARM service using that context.
 628  *
 629  * @param cfg configuration to use (needed to contact ARM;
 630  *        the ARM service may internally use a different
 631  *        configuration to determine how to start the service).
 632  * @param conn_status will be called when connecting/disconnecting
 633  * @param cls closure for conn_status
 634  * @return context to use for further ARM operations, NULL on error.
 635  */
 636 struct GNUNET_ARM_Handle *
 637 GNUNET_ARM_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
 638                     GNUNET_ARM_ConnectionStatusCallback conn_status, void *cls)
 639 {
 640   struct GNUNET_ARM_Handle *h;
 641
 642   h = GNUNET_new (struct GNUNET_ARM_Handle);
 643   h->cfg = GNUNET_CONFIGURATION_dup (cfg);
 644   h->currently_down = GNUNET_YES;
 645   h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
 646   h->conn_status = conn_status;
 647   h->conn_status_cls = cls;
 648   if (GNUNET_OK != reconnect_arm (h))
 649   {
 650     GNUNET_free (h);
 651     return NULL;
 652   }
 653   return h;
 654 }
 655
 656
 657 /**
 658  * Disconnect from the ARM service (if connected) and destroy the context.
 659  *
 660  * @param h the handle that was being used
 661  */
 662 void
 663 GNUNET_ARM_disconnect_and_free (struct GNUNET_ARM_Handle *h)
 664 {
 665   struct ARMControlMessage *cm;
 666
 667   LOG (GNUNET_ERROR_TYPE_DEBUG, "Disconnecting from ARM service\n");
 668   if (NULL != h->cth)
 669   {
 670     GNUNET_CLIENT_notify_transmit_ready_cancel (h->cth);
 671     h->cth = NULL;
 672   }
 673   while ((NULL != (cm = h->control_pending_head))
 674          || (NULL != (cm = h->control_sent_head)) )
 675   {
 676     if (NULL != h->control_pending_head)
 677       GNUNET_CONTAINER_DLL_remove (h->control_pending_head,
 678                                    h->control_pending_tail, cm);
 679     else
 680       GNUNET_CONTAINER_DLL_remove (h->control_sent_head,
 681                                    h->control_sent_tail, cm);
 682     GNUNET_assert (GNUNET_SCHEDULER_NO_TASK != cm->timeout_task_id);
 683     GNUNET_SCHEDULER_cancel (cm->timeout_task_id);
 684     if (NULL != cm->result_cont)
 685       cm->result_cont (cm->cont_cls, GNUNET_ARM_REQUEST_DISCONNECTED,
 686                        NULL, 0);
 687     /* FIXME: What about list callback? */
 688     GNUNET_free_non_null (cm->msg);
 689     GNUNET_free (cm);
 690   }
 691   if (NULL != h->client)
 692   {
 693     GNUNET_CLIENT_disconnect (h->client);
 694     h->client = NULL;
 695   }
 696   if (GNUNET_SCHEDULER_NO_TASK != h->reconnect_task)
 697   {
 698     GNUNET_SCHEDULER_cancel (h->reconnect_task);
 699     h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
 700   }
 701   if (GNUNET_NO == h->service_test_is_active)
 702   {
 703     GNUNET_CONFIGURATION_destroy (h->cfg);
 704     GNUNET_free (h);
 705   }
 706 }
 707
 708
 709 /**
 710  * Message timed out. Remove it from the queue.
 711  *
 712  * @param cls the message (struct ARMControlMessage *)
 713  * @param tc task context
 714  */
 715 static void
 716 control_message_timeout (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 717 {
 718   struct ARMControlMessage *cm = cls;
 719   struct GNUNET_ARM_Message *arm_msg;
 720
 721   LOG (GNUNET_ERROR_TYPE_DEBUG,
 722        "Control message timed out\n");
 723   arm_msg = cm->msg;
 724   if ((NULL == arm_msg) || (0 == arm_msg->request_id))
 725   {
 726     GNUNET_CONTAINER_DLL_remove (cm->h->control_pending_head,
 727                                  cm->h->control_pending_tail, cm);
 728   }
 729   else
 730   {
 731     GNUNET_CONTAINER_DLL_remove (cm->h->control_sent_head,
 732                                  cm->h->control_sent_tail, cm);
 733   }
 734   if (NULL != cm->result_cont)
 735     cm->result_cont (cm->cont_cls, GNUNET_ARM_REQUEST_TIMEOUT, NULL, 0);
 736   else if (NULL != cm->list_cont)
 737     cm->list_cont (cm->cont_cls, GNUNET_ARM_REQUEST_TIMEOUT, 0, NULL);
 738   GNUNET_free_non_null (cm->msg);
 739   GNUNET_free (cm);
 740 }
 741
 742
 743 /**
 744  * A client specifically requested starting of ARM itself.
 745  * This function is called with information about whether
 746  * or not ARM is running; if it is, report success.  If
 747  * it is not, start the ARM process.
 748  *
 749  * @param cls the context for the request that we will report on (struct ARMControlMessage *)
 750  * @param result GNUNET_YES if ARM is running
 751  */
 752 static void
 753 arm_service_report (void *cls,
 754                     int result)
 755 {
 756   struct ARMControlMessage *cm = cls;
 757   struct GNUNET_ARM_Handle *h;
 758   struct GNUNET_OS_Process *proc;
 759   unsigned char test_is_active;
 760   char *cbinary;
 761   char *binary;
 762   char *quotedbinary;
 763   char *config;
 764   char *loprefix;
 765   char *lopostfix;
 766
 767   test_is_active = cm->h->service_test_is_active;
 768   if ((GNUNET_YES == test_is_active) &&
 769       (GNUNET_YES == result))
 770   {
 771     LOG (GNUNET_ERROR_TYPE_DEBUG,
 772          "Looks like `%s' is already running.\n",
 773          "gnunet-service-arm");
 774     /* arm is running! */
 775     if (cm->result_cont)
 776       cm->result_cont (cm->cont_cls,
 777                        GNUNET_ARM_REQUEST_SENT_OK, "arm",
 778                        GNUNET_ARM_RESULT_IS_STARTED_ALREADY);
 779   }
 780   if (GNUNET_NO == test_is_active)
 781   {
 782     /* User disconnected & destroyed ARM handle in the middle of
 783      * the service test, so we kept the handle around until now.
 784      */
 785     GNUNET_CONFIGURATION_destroy (cm->h->cfg);
 786     GNUNET_free (cm->h);
 787   }
 788   if ((GNUNET_YES == result) ||
 789       (GNUNET_NO == test_is_active))
 790   {
 791     GNUNET_free (cm);
 792     return;
 793   }
 794   cm->h->service_test_is_active = GNUNET_NO;
 795   LOG (GNUNET_ERROR_TYPE_DEBUG,
 796        "Looks like `%s' is not running, will start it.\n",
 797        "gnunet-service-arm");
 798   if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_string (
 799       cm->h->cfg, "arm", "PREFIX", &loprefix))
 800     loprefix = GNUNET_strdup ("");
 801   if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_string (
 802       cm->h->cfg, "arm", "OPTIONS", &lopostfix))
 803     lopostfix = GNUNET_strdup ("");
 804   if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_string (
 805       cm->h->cfg, "arm", "BINARY", &cbinary))
 806   {
 807     GNUNET_log_config_missing (GNUNET_ERROR_TYPE_WARNING, "arm", "BINARY");
 808     if (cm->result_cont)
 809       cm->result_cont (cm->cont_cls,
 810                        GNUNET_ARM_REQUEST_SENT_OK, "arm",
 811                        GNUNET_ARM_RESULT_IS_NOT_KNOWN);
 812     GNUNET_free (cm);
 813     GNUNET_free (loprefix);
 814     GNUNET_free (lopostfix);
 815     return;
 816   }
 817   if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_filename (
 818       cm->h->cfg, "arm", "CONFIG", &config))
 819     config = NULL;
 820   binary = GNUNET_OS_get_libexec_binary_path (cbinary);
 821   GNUNET_asprintf (&quotedbinary,
 822                    "\"%s\"",
 823                    binary);
 824   GNUNET_free (cbinary);
 825   if ((GNUNET_YES == GNUNET_CONFIGURATION_have_value (
 826           cm->h->cfg, "TESTING", "WEAKRANDOM")) &&
 827       (GNUNET_YES == GNUNET_CONFIGURATION_get_value_yesno (
 828           cm->h->cfg, "TESTING", "WEAKRANDOM")) &&
 829       (GNUNET_NO == GNUNET_CONFIGURATION_have_value (
 830           cm->h->cfg, "TESTING", "HOSTFILE")))
 831   {
 832     /* Means we are ONLY running locally */
 833     /* we're clearly running a test, don't daemonize */
 834     if (NULL == config)
 835       proc = GNUNET_OS_start_process_s (GNUNET_NO, cm->std_inheritance,
 836                                         NULL, loprefix, quotedbinary,
 837                                         /* no daemonization! */
 838                                         lopostfix, NULL);
 839     else
 840       proc = GNUNET_OS_start_process_s (GNUNET_NO, cm->std_inheritance,
 841                                NULL, loprefix, quotedbinary, "-c", config,
 842                                         /* no daemonization! */
 843                                         lopostfix, NULL);
 844   }
 845   else
 846   {
 847     if (NULL == config)
 848       proc = GNUNET_OS_start_process_s (GNUNET_NO, cm->std_inheritance,
 849                                         NULL, loprefix, quotedbinary,
 850                                         "-d", lopostfix, NULL);
 851     else
 852       proc = GNUNET_OS_start_process_s (GNUNET_NO, cm->std_inheritance,
 853                                         NULL, loprefix, quotedbinary, "-c",
 854                                         config,
 855                                         "-d", lopostfix, NULL);
 856   }
 857   GNUNET_free (binary);
 858   GNUNET_free (quotedbinary);
 859   GNUNET_free_non_null (config);
 860   GNUNET_free (loprefix);
 861   GNUNET_free (lopostfix);
 862   if (NULL == proc)
 863   {
 864     if (cm->result_cont)
 865       cm->result_cont (cm->cont_cls, GNUNET_ARM_REQUEST_SENT_OK, "arm",
 866           GNUNET_ARM_RESULT_START_FAILED);
 867     GNUNET_free (cm);
 868     return;
 869   }
 870   if (cm->result_cont)
 871     cm->result_cont (cm->cont_cls, GNUNET_ARM_REQUEST_SENT_OK, "arm",
 872         GNUNET_ARM_RESULT_STARTING);
 873   GNUNET_OS_process_destroy (proc);
 874   h = cm->h;
 875   GNUNET_free (cm);
 876   reconnect_arm (h);
 877 }
 878
 879
 880 /**
 881  * Start or stop a service.
 882  *
 883  * @param h handle to ARM
 884  * @param service_name name of the service
 885  * @param timeout how long to wait before failing for good
 886  * @param cb callback to invoke when service is ready
 887  * @param cb_cls closure for callback
 888  * @param type type of the request
 889  */
 890 static void
 891 change_service (struct GNUNET_ARM_Handle *h, const char *service_name,
 892                 struct GNUNET_TIME_Relative timeout, GNUNET_ARM_ResultCallback cb,
 893                 void *cb_cls, uint16_t type)
 894 {
 895   struct ARMControlMessage *cm;
 896   size_t slen;
 897   struct GNUNET_ARM_Message *msg;
 898
 899   slen = strlen (service_name) + 1;
 900   if (slen + sizeof (struct GNUNET_ARM_Message) >=
 901       GNUNET_SERVER_MAX_MESSAGE_SIZE)
 902   {
 903     GNUNET_break (0);
 904     if (cb != NULL)
 905       cb (cb_cls, GNUNET_ARM_REQUEST_TOO_LONG, NULL, 0);
 906     return;
 907   }
 908   LOG (GNUNET_ERROR_TYPE_DEBUG, "Requesting %s of service `%s'.\n",
 909        (GNUNET_MESSAGE_TYPE_ARM_START == type) ? "start" : "termination",
 910        service_name);
 911   cm = GNUNET_malloc (sizeof (struct ARMControlMessage) + slen);
 912   cm->h = h;
 913   cm->result_cont = cb;
 914   cm->cont_cls = cb_cls;
 915   cm->timeout = GNUNET_TIME_relative_to_absolute (timeout);
 916   memcpy (&cm[1], service_name, slen);
 917   msg = GNUNET_malloc (sizeof (struct GNUNET_ARM_Message) + slen);
 918   msg->header.size = htons (sizeof (struct GNUNET_ARM_Message) + slen);
 919   msg->header.type = htons (type);
 920   msg->reserved = htonl (0);
 921   memcpy (&msg[1], service_name, slen);
 922   cm->msg = msg;
 923   LOG (GNUNET_ERROR_TYPE_DEBUG,
 924       "Inserting a control message into the queue. Timeout is %s\n",
 925        GNUNET_STRINGS_relative_time_to_string (GNUNET_TIME_absolute_get_remaining (cm->timeout),
 926                                                GNUNET_NO));
 927   GNUNET_CONTAINER_DLL_insert_tail (h->control_pending_head,
 928                                     h->control_pending_tail, cm);
 929   cm->timeout_task_id =
 930       GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_absolute_get_remaining
 931                                     (cm->timeout), &control_message_timeout, cm);
 932   trigger_next_request (h, GNUNET_NO);
 933 }
 934
 935
 936 /**
 937  * Request for a service to be started.
 938  *
 939  * @param h handle to ARM
 940  * @param service_name name of the service
 941  * @param std_inheritance inheritance of std streams
 942  * @param timeout how long to wait before failing for good
 943  * @param cont callback to invoke after request is sent or not sent
 944  * @param cont_cls closure for callback
 945  */
 946 void
 947 GNUNET_ARM_request_service_start (struct GNUNET_ARM_Handle *h,
 948                                   const char *service_name,
 949                                   enum GNUNET_OS_InheritStdioFlags std_inheritance,
 950                                   struct GNUNET_TIME_Relative timeout,
 951                                   GNUNET_ARM_ResultCallback cont,
 952                                   void *cont_cls)
 953 {
 954   struct ARMControlMessage *cm;
 955   size_t slen;
 956
 957   LOG (GNUNET_ERROR_TYPE_DEBUG,
 958        "Asked to start service `%s' within %s\n", service_name,
 959        GNUNET_STRINGS_relative_time_to_string (timeout, GNUNET_NO));
 960   if (0 == strcasecmp ("arm", service_name))
 961   {
 962     /* Possible cases:
 963      * 1) We're connected to ARM already. Invoke the callback immediately.
 964      * 2) We're not connected to ARM.
 965      *    Cancel any reconnection attempts temporarily, then perform
 966      *    a service test.
 967      */
 968     if (GNUNET_NO == h->currently_down)
 969     {
 970       LOG (GNUNET_ERROR_TYPE_DEBUG, "ARM is already running\n");
 971       if (NULL != cont)
 972         cont (cont_cls, GNUNET_ARM_REQUEST_SENT_OK, "arm", GNUNET_ARM_RESULT_IS_STARTED_ALREADY);
 973     }
 974     else if (GNUNET_NO == h->service_test_is_active)
 975     {
 976       if (NULL != h->cth)
 977       {
 978         GNUNET_CLIENT_notify_transmit_ready_cancel (h->cth);
 979         h->cth = NULL;
 980       }
 981       if (NULL != h->client)
 982       {
 983         GNUNET_CLIENT_disconnect (h->client);
 984         h->client = NULL;
 985       }
 986       if (GNUNET_SCHEDULER_NO_TASK != h->reconnect_task)
 987       {
 988         GNUNET_SCHEDULER_cancel (h->reconnect_task);
 989         h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
 990       }
 991
 992       LOG (GNUNET_ERROR_TYPE_DEBUG,
 993           "Not connected to ARM, will do a service test\n");
 994
 995       slen = strlen ("arm") + 1;
 996       cm = GNUNET_malloc (sizeof (struct ARMControlMessage) + slen);
 997       cm->h = h;
 998       cm->result_cont = cont;
 999       cm->cont_cls = cont_cls;
1000       cm->timeout = GNUNET_TIME_relative_to_absolute (timeout);
1001       cm->std_inheritance = std_inheritance;
1002       memcpy (&cm[1], service_name, slen);
1003       h->service_test_is_active = GNUNET_YES;
1004       GNUNET_CLIENT_service_test ("arm", h->cfg, timeout, &arm_service_report,
1005                                   cm);
1006     }
1007     else
1008     {
1009       /* Service test is already running - tell user to chill out and try
1010        * again later.
1011        */
1012       LOG (GNUNET_ERROR_TYPE_DEBUG, "Service test is already in progress, we're busy\n");
1013       if (NULL != cont)
1014         cont (cont_cls, GNUNET_ARM_REQUEST_BUSY, NULL, 0);
1015     }
1016     return;
1017   }
1018   change_service (h, service_name, timeout, cont, cont_cls,
1019                   GNUNET_MESSAGE_TYPE_ARM_START);
1020 }
1021
1022
1023 /**
1024  * Request a service to be stopped.
1025  * Stopping arm itself will not invalidate its handle, and
1026  * ARM API will try to restore connection to the ARM service,
1027  * even if ARM connection was lost because you asked for ARM to be stopped.
1028  * Call GNUNET_ARM_disconnect_and_free () to free the handle and prevent
1029  * further connection attempts.
1030  *
1031  * @param h handle to ARM
1032  * @param service_name name of the service
1033  * @param timeout how long to wait before failing for good
1034  * @param cont callback to invoke after request is sent or is not sent
1035  * @param cont_cls closure for callback
1036  */
1037 void
1038 GNUNET_ARM_request_service_stop (struct GNUNET_ARM_Handle *h,
1039                                  const char *service_name,
1040                                  struct GNUNET_TIME_Relative timeout,
1041                                  GNUNET_ARM_ResultCallback cont,
1042                                  void *cont_cls)
1043 {
1044   LOG (GNUNET_ERROR_TYPE_DEBUG,
1045        "Stopping service `%s' within %s\n",
1046        service_name,
1047        GNUNET_STRINGS_relative_time_to_string (timeout, GNUNET_NO));
1048   change_service (h, service_name, timeout, cont, cont_cls,
1049                   GNUNET_MESSAGE_TYPE_ARM_STOP);
1050 }
1051
1052
1053 /**
1054  * Request a list of running services.
1055  *
1056  * @param h handle to ARM
1057  * @param timeout how long to wait before failing for good
1058  * @param cont callback to invoke after request is sent or is not sent
1059  * @param cont_cls closure for callback
1060  */
1061 void
1062 GNUNET_ARM_request_service_list (struct GNUNET_ARM_Handle *h,
1063                                  struct GNUNET_TIME_Relative timeout,
1064                                  GNUNET_ARM_ServiceListCallback cont,
1065                                  void *cont_cls)
1066 {
1067   struct ARMControlMessage *cm;
1068   struct GNUNET_ARM_Message *msg;
1069
1070   LOG (GNUNET_ERROR_TYPE_DEBUG,
1071        "Requesting LIST from ARM service with timeout: %s\n",
1072        GNUNET_STRINGS_relative_time_to_string (timeout, GNUNET_YES));
1073   cm = GNUNET_new (struct ARMControlMessage);
1074   cm->h = h;
1075   cm->list_cont = cont;
1076   cm->cont_cls = cont_cls;
1077   cm->timeout = GNUNET_TIME_relative_to_absolute (timeout);
1078   msg = GNUNET_malloc (sizeof (struct GNUNET_ARM_Message));
1079   msg->header.size = htons (sizeof (struct GNUNET_ARM_Message));
1080   msg->header.type = htons (GNUNET_MESSAGE_TYPE_ARM_LIST);
1081   msg->reserved = htonl (0);
1082   cm->msg = msg;
1083   GNUNET_CONTAINER_DLL_insert_tail (h->control_pending_head,
1084                                     h->control_pending_tail, cm);
1085   cm->timeout_task_id =
1086       GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_absolute_get_remaining
1087                                     (cm->timeout), &control_message_timeout, cm);
1088   trigger_next_request (h, GNUNET_NO);
1089 }
1090
1091
1092 /* end of arm_api.c */