src/arm/arm_api.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2009, 2010, 2012 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  */
  26 #include "platform.h"
  27 #include "gnunet_arm_service.h"
  28 #include "gnunet_client_lib.h"
  29 #include "gnunet_getopt_lib.h"
  30 #include "gnunet_os_lib.h"
  31 #include "gnunet_protocols.h"
  32 #include "gnunet_server_lib.h"
  33 #include "arm.h"
  34
  35 #define LOG(kind,...) GNUNET_log_from (kind, "arm-api",__VA_ARGS__)
  36
  37 /**
  38  * Handle for interacting with ARM.
  39  */
  40 struct GNUNET_ARM_Handle
  41 {
  42
  43   /**
  44    * Our connection to the ARM service.
  45    */
  46   struct GNUNET_CLIENT_Connection *client;
  47
  48   /**
  49    * The configuration that we are using.
  50    */
  51   struct GNUNET_CONFIGURATION_Handle *cfg;
  52
  53 };
  54
  55 /**
  56  * Context for handling the shutdown of a service.
  57  */
  58 struct ShutdownContext
  59 {
  60   /**
  61    * Connection to the service that is being shutdown.
  62    */
  63   struct GNUNET_CLIENT_Connection *sock;
  64
  65   /**
  66    * Time allowed for shutdown to happen.
  67    */
  68   struct GNUNET_TIME_Absolute timeout;
  69
  70   /**
  71    * Task set up to cancel the shutdown request on timeout.
  72    */
  73   GNUNET_SCHEDULER_TaskIdentifier cancel_task;
  74
  75   /**
  76    * Task to call once shutdown complete
  77    */
  78   GNUNET_CLIENT_ShutdownTask cont;
  79
  80   /**
  81    * Closure for shutdown continuation
  82    */
  83   void *cont_cls;
  84
  85   /**
  86    * Handle for transmission request.
  87    */
  88   struct GNUNET_CLIENT_TransmitHandle *th;
  89
  90 };
  91
  92
  93 /**
  94  * Handler receiving response to service shutdown requests.
  95  * First call with NULL: service misbehaving, or something.
  96  * First call with GNUNET_MESSAGE_TYPE_ARM_SHUTDOWN_ACK:
  97  *   - service will shutdown
  98  * Second call with NULL:
  99  *   - service has now really shut down.
 100  *
 101  * @param cls closure
 102  * @param msg NULL, indicating socket closure.
 103  */
 104 static void
 105 service_shutdown_handler (void *cls, const struct GNUNET_MessageHeader *msg)
 106 {
 107   struct ShutdownContext *shutdown_ctx = cls;
 108
 109   if (NULL != msg)
 110   {
 111     /* We just expected a disconnect! Report the error and be done with it... */
 112     GNUNET_break (0);
 113     shutdown_ctx->cont (shutdown_ctx->cont_cls, GNUNET_ARM_PROCESS_COMMUNICATION_ERROR);
 114     GNUNET_SCHEDULER_cancel (shutdown_ctx->cancel_task);
 115     GNUNET_CLIENT_disconnect (shutdown_ctx->sock);
 116     GNUNET_free (shutdown_ctx);
 117     return;
 118   }
 119   if (NULL != shutdown_ctx->cont)
 120     /* shutdown is now complete, as we waited for the network disconnect... */
 121     shutdown_ctx->cont (shutdown_ctx->cont_cls, GNUNET_ARM_PROCESS_DOWN);
 122   GNUNET_SCHEDULER_cancel (shutdown_ctx->cancel_task);
 123   GNUNET_CLIENT_disconnect (shutdown_ctx->sock);
 124   GNUNET_free (shutdown_ctx);
 125 }
 126
 127
 128 /**
 129  * Shutting down took too long, cancel receive and return error.
 130  *
 131  * @param cls closure
 132  * @param tc context information (why was this task triggered now)
 133  */
 134 static void
 135 service_shutdown_cancel (void *cls,
 136                          const struct GNUNET_SCHEDULER_TaskContext *tc)
 137 {
 138   struct ShutdownContext *shutdown_ctx = cls;
 139
 140   shutdown_ctx->cont (shutdown_ctx->cont_cls, GNUNET_ARM_PROCESS_COMMUNICATION_TIMEOUT);
 141   GNUNET_CLIENT_disconnect (shutdown_ctx->sock);
 142   GNUNET_free (shutdown_ctx);
 143 }
 144
 145
 146 /**
 147  * If possible, write a shutdown message to the target
 148  * buffer and destroy the client connection.
 149  *
 150  * @param cls the "struct GNUNET_CLIENT_Connection" to destroy
 151  * @param size number of bytes available in buf
 152  * @param buf NULL on error, otherwise target buffer
 153  * @return number of bytes written to buf
 154  */
 155 static size_t
 156 write_shutdown (void *cls, size_t size, void *buf)
 157 {
 158   struct ShutdownContext *shutdown_ctx = cls;
 159   struct GNUNET_MessageHeader *msg;
 160
 161   shutdown_ctx->th = NULL;
 162   if (size < sizeof (struct GNUNET_MessageHeader))
 163   {
 164     LOG (GNUNET_ERROR_TYPE_WARNING,
 165          _("Failed to transmit shutdown request to client.\n"));
 166     shutdown_ctx->cont (shutdown_ctx->cont_cls, GNUNET_ARM_PROCESS_COMMUNICATION_ERROR);
 167     GNUNET_CLIENT_disconnect (shutdown_ctx->sock);
 168     GNUNET_free (shutdown_ctx);
 169     return 0;                   /* client disconnected */
 170   }
 171   GNUNET_CLIENT_receive (shutdown_ctx->sock, &service_shutdown_handler,
 172                          shutdown_ctx, GNUNET_TIME_UNIT_FOREVER_REL);
 173   shutdown_ctx->cancel_task =
 174     GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_absolute_get_remaining
 175                                   (shutdown_ctx->timeout),
 176                                   &service_shutdown_cancel, shutdown_ctx);
 177   msg = (struct GNUNET_MessageHeader *) buf;
 178   msg->type = htons (GNUNET_MESSAGE_TYPE_ARM_SHUTDOWN);
 179   msg->size = htons (sizeof (struct GNUNET_MessageHeader));
 180   return sizeof (struct GNUNET_MessageHeader);
 181 }
 182
 183
 184 /**
 185  * Request that the service should shutdown.
 186  * Afterwards, the connection will automatically be
 187  * disconnected.  Hence the "sock" should not
 188  * be used by the caller after this call
 189  * (calling this function frees "sock" after a while).
 190  *
 191  * @param sock the socket connected to the service
 192  * @param timeout how long to wait before giving up on transmission
 193  * @param cont continuation to call once the service is really down
 194  * @param cont_cls closure for continuation
 195  *
 196  */
 197 static void
 198 arm_service_shutdown (struct GNUNET_CLIENT_Connection *sock,
 199                       struct GNUNET_TIME_Relative timeout,
 200                       GNUNET_CLIENT_ShutdownTask cont, void *cont_cls)
 201 {
 202   struct ShutdownContext *shutdown_ctx;
 203
 204   shutdown_ctx = GNUNET_malloc (sizeof (struct ShutdownContext));
 205   shutdown_ctx->cont = cont;
 206   shutdown_ctx->cont_cls = cont_cls;
 207   shutdown_ctx->sock = sock;
 208   shutdown_ctx->timeout = GNUNET_TIME_relative_to_absolute (timeout);
 209   shutdown_ctx->th = GNUNET_CLIENT_notify_transmit_ready (sock,
 210                                                           sizeof (struct GNUNET_MessageHeader),
 211                                                           timeout, GNUNET_NO, &write_shutdown,
 212                                                           shutdown_ctx);
 213 }
 214
 215
 216 /**
 217  * Setup a context for communicating with ARM.  Note that this
 218  * can be done even if the ARM service is not yet running.
 219  *
 220  * @param cfg configuration to use (needed to contact ARM;
 221  *        the ARM service may internally use a different
 222  *        configuration to determine how to start the service).
 223  * @param service service that *this* process is implementing/providing, can be NULL
 224  * @return context to use for further ARM operations, NULL on error
 225  */
 226 struct GNUNET_ARM_Handle *
 227 GNUNET_ARM_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
 228                     const char *service)
 229 {
 230   struct GNUNET_ARM_Handle *ret;
 231
 232   ret = GNUNET_malloc (sizeof (struct GNUNET_ARM_Handle));
 233   ret->cfg = GNUNET_CONFIGURATION_dup (cfg);
 234   return ret;
 235 }
 236
 237
 238 /**
 239  * Disconnect from the ARM service.
 240  *
 241  * @param h the handle that was being used
 242  */
 243 void
 244 GNUNET_ARM_disconnect (struct GNUNET_ARM_Handle *h)
 245 {
 246   if (h->client != NULL)
 247     GNUNET_CLIENT_disconnect (h->client);
 248   GNUNET_CONFIGURATION_destroy (h->cfg);
 249   GNUNET_free (h);
 250 }
 251
 252
 253 struct ARM_ShutdownContext
 254 {
 255   /**
 256    * Callback to call once shutdown complete.
 257    */
 258   GNUNET_ARM_Callback cb;
 259
 260   /**
 261    * Closure for callback.
 262    */
 263   void *cb_cls;
 264 };
 265
 266
 267 /**
 268  * Internal state for a request with ARM.
 269  */
 270 struct RequestContext
 271 {
 272
 273   /**
 274    * Pointer to our handle with ARM.
 275    */
 276   struct GNUNET_ARM_Handle *h;
 277
 278   /**
 279    * Function to call with a status code for the requested operation.
 280    */
 281   GNUNET_ARM_Callback callback;
 282
 283   /**
 284    * Closure for "callback".
 285    */
 286   void *cls;
 287
 288   /**
 289    * Timeout for the operation.
 290    */
 291   struct GNUNET_TIME_Absolute timeout;
 292
 293   /**
 294    * Type of the request expressed as a message type (start or stop).
 295    */
 296   uint16_t type;
 297
 298   /**
 299    * Flags for passing std descriptors to ARM (when starting ARM).
 300    */
 301   enum GNUNET_OS_InheritStdioFlags std_inheritance;
 302
 303 };
 304
 305 #include "do_start_process.c"
 306
 307
 308 /**
 309  * A client specifically requested starting of ARM itself.
 310  * This function is called with information about whether
 311  * or not ARM is running; if it is, report success.  If
 312  * it is not, start the ARM process.
 313  *
 314  * @param cls the context for the request that we will report on (struct RequestContext*)
 315  * @param tc why were we called (reason says if ARM is running)
 316  */
 317 static void
 318 arm_service_report (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 319 {
 320   struct RequestContext *pos = cls;
 321   struct GNUNET_OS_Process *proc;
 322   char *binary;
 323   char *config;
 324   char *loprefix;
 325   char *lopostfix;
 326
 327   if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_PREREQ_DONE))
 328   {
 329     LOG (GNUNET_ERROR_TYPE_DEBUG, "Looks like `%s' is already running.\n",
 330          "gnunet-service-arm");
 331     /* arm is running! */
 332     if (pos->callback != NULL)
 333       pos->callback (pos->cls, GNUNET_ARM_PROCESS_ALREADY_RUNNING);
 334     GNUNET_free (pos);
 335     return;
 336   }
 337   LOG (GNUNET_ERROR_TYPE_DEBUG,
 338        "Looks like `%s' is not running, will start it.\n",
 339        "gnunet-service-arm");
 340   if (GNUNET_OK !=
 341       GNUNET_CONFIGURATION_get_value_string (pos->h->cfg, "arm", "PREFIX",
 342                                              &loprefix))
 343     loprefix = GNUNET_strdup ("");
 344   if (GNUNET_OK !=
 345       GNUNET_CONFIGURATION_get_value_string (pos->h->cfg, "arm", "OPTIONS",
 346                                              &lopostfix))
 347     lopostfix = GNUNET_strdup ("");
 348   if (GNUNET_OK !=
 349       GNUNET_CONFIGURATION_get_value_string (pos->h->cfg, "arm", "BINARY",
 350                                              &binary))
 351   {
 352     GNUNET_log_config_missing (GNUNET_ERROR_TYPE_WARNING,
 353                                "arm", "BINARY");
 354     if (pos->callback != NULL)
 355       pos->callback (pos->cls, GNUNET_ARM_PROCESS_UNKNOWN);
 356     GNUNET_free (pos);
 357     GNUNET_free (loprefix);
 358     GNUNET_free (lopostfix);
 359     return;
 360   }
 361   if (GNUNET_OK !=
 362       GNUNET_CONFIGURATION_get_value_filename (pos->h->cfg, "arm", "CONFIG",
 363                                                &config))
 364   {
 365     GNUNET_log_config_missing (GNUNET_ERROR_TYPE_WARNING,
 366                                "arm", "CONFIG");
 367     if (pos->callback != NULL)
 368       pos->callback (pos->cls, GNUNET_ARM_PROCESS_UNKNOWN);
 369     GNUNET_free (binary);
 370     GNUNET_free (pos);
 371     GNUNET_free (loprefix);
 372     GNUNET_free (lopostfix);
 373     return;
 374   }
 375   if ((GNUNET_YES ==
 376        GNUNET_CONFIGURATION_have_value (pos->h->cfg, "TESTING", "WEAKRANDOM"))
 377       && (GNUNET_YES ==
 378           GNUNET_CONFIGURATION_get_value_yesno (pos->h->cfg, "TESTING",
 379                                                 "WEAKRANDOM"))
 380       && (GNUNET_NO ==
 381           GNUNET_CONFIGURATION_have_value (pos->h->cfg, "TESTING",
 382                                            "HOSTFILE")))
 383   {
 384     /* Means we are ONLY running locally */
 385     /* we're clearly running a test, don't daemonize */
 386     proc = do_start_process (GNUNET_NO, pos->std_inheritance,
 387                              NULL, loprefix, binary, "-c", config,
 388                              /* no daemonization! */
 389                              lopostfix, NULL);
 390   }
 391   else
 392   {
 393     proc = do_start_process (GNUNET_NO, pos->std_inheritance,
 394                              NULL, loprefix, binary, "-c", config,
 395                              "-d", lopostfix, NULL);
 396   }
 397   GNUNET_free (binary);
 398   GNUNET_free (config);
 399   GNUNET_free (loprefix);
 400   GNUNET_free (lopostfix);
 401   if (proc == NULL)
 402     {
 403       if (pos->callback != NULL)
 404         pos->callback (pos->cls, GNUNET_ARM_PROCESS_FAILURE);
 405       GNUNET_free (pos);
 406       return;
 407     }
 408   if (pos->callback != NULL)
 409     pos->callback (pos->cls, GNUNET_ARM_PROCESS_STARTING);
 410   GNUNET_free (proc);
 411   GNUNET_free (pos);
 412 }
 413
 414
 415 /**
 416  * Process a response from ARM to a request for a change in service
 417  * status.
 418  *
 419  * @param cls the request context
 420  * @param msg the response
 421  */
 422 static void
 423 handle_response (void *cls, const struct GNUNET_MessageHeader *msg)
 424 {
 425   struct RequestContext *sc = cls;
 426   const struct GNUNET_ARM_ResultMessage *res;
 427   enum GNUNET_ARM_ProcessStatus status;
 428
 429   if ((msg == NULL) ||
 430       (ntohs (msg->size) != sizeof (struct GNUNET_ARM_ResultMessage)))
 431   {
 432     GNUNET_break (0);
 433     GNUNET_CLIENT_disconnect (sc->h->client);
 434     sc->h->client = GNUNET_CLIENT_connect ("arm", sc->h->cfg);
 435     GNUNET_assert (NULL != sc->h->client);
 436     if (sc->callback != NULL)
 437       sc->callback (sc->cls, GNUNET_ARM_PROCESS_COMMUNICATION_ERROR);
 438     GNUNET_free (sc);
 439     return;
 440   }
 441   res = (const struct GNUNET_ARM_ResultMessage *) msg;
 442   LOG (GNUNET_ERROR_TYPE_DEBUG,
 443        "Received response from ARM for service `%s': %u\n",
 444        (const char *) &sc[1], ntohs (msg->type));
 445   status = (enum GNUNET_ARM_ProcessStatus) ntohl (res->status);
 446   if (sc->callback != NULL)
 447     sc->callback (sc->cls, status);
 448   GNUNET_free (sc);
 449 }
 450
 451
 452 /**
 453  * Start or stop a service.
 454  *
 455  * @param h handle to ARM
 456  * @param service_name name of the service
 457  * @param timeout how long to wait before failing for good
 458  * @param cb callback to invoke when service is ready
 459  * @param cb_cls closure for callback
 460  * @param type type of the request
 461  */
 462 static void
 463 change_service (struct GNUNET_ARM_Handle *h, const char *service_name,
 464                 struct GNUNET_TIME_Relative timeout, GNUNET_ARM_Callback cb,
 465                 void *cb_cls, uint16_t type)
 466 {
 467   struct RequestContext *sctx;
 468   size_t slen;
 469   struct GNUNET_MessageHeader *msg;
 470
 471   slen = strlen (service_name) + 1;
 472   if (slen + sizeof (struct GNUNET_MessageHeader) >=
 473       GNUNET_SERVER_MAX_MESSAGE_SIZE)
 474   {
 475     GNUNET_break (0);
 476     if (cb != NULL)
 477       cb (cb_cls, GNUNET_NO);
 478     return;
 479   }
 480   LOG (GNUNET_ERROR_TYPE_DEBUG,
 481        (type ==
 482         GNUNET_MESSAGE_TYPE_ARM_START) ?
 483        "Requesting start of service `%s'.\n" :
 484        "Requesting termination of service `%s'.\n", service_name);
 485   sctx = GNUNET_malloc (sizeof (struct RequestContext) + slen);
 486   sctx->h = h;
 487   sctx->callback = cb;
 488   sctx->cls = cb_cls;
 489   sctx->timeout = GNUNET_TIME_relative_to_absolute (timeout);
 490   sctx->type = type;
 491   memcpy (&sctx[1], service_name, slen);
 492   msg = GNUNET_malloc (sizeof (struct GNUNET_MessageHeader) + slen);
 493   msg->size = htons (sizeof (struct GNUNET_MessageHeader) + slen);
 494   msg->type = htons (sctx->type);
 495   memcpy (&msg[1], service_name, slen);
 496   if (GNUNET_OK !=
 497       GNUNET_CLIENT_transmit_and_get_response (sctx->h->client, msg,
 498                                                GNUNET_TIME_absolute_get_remaining
 499                                                (sctx->timeout), GNUNET_YES,
 500                                                &handle_response, sctx))
 501   {
 502     GNUNET_break (0);
 503     if (cb != NULL)
 504       cb (cb_cls, GNUNET_SYSERR);
 505     GNUNET_free (sctx);
 506     GNUNET_free (msg);
 507     return;
 508   }
 509   GNUNET_free (msg);
 510 }
 511
 512
 513 /**
 514  * Start a service.
 515  *
 516  * @param h handle to ARM
 517  * @param service_name name of the service
 518  * @param std_inheritance inheritance of std streams
 519  * @param timeout how long to wait before failing for good
 520  * @param cb callback to invoke when service is ready
 521  * @param cb_cls closure for callback
 522  */
 523 void
 524 GNUNET_ARM_start_service (struct GNUNET_ARM_Handle *h,
 525                           const char *service_name,
 526                           enum GNUNET_OS_InheritStdioFlags std_inheritance,
 527                           struct GNUNET_TIME_Relative timeout,
 528                           GNUNET_ARM_Callback cb, void *cb_cls)
 529 {
 530   struct RequestContext *sctx;
 531   struct GNUNET_CLIENT_Connection *client;
 532   size_t slen;
 533
 534   LOG (GNUNET_ERROR_TYPE_DEBUG,
 535        "Asked to start service `%s' within %s\n", service_name,
 536        GNUNET_STRINGS_relative_time_to_string (timeout));
 537   if (0 == strcasecmp ("arm", service_name))
 538   {
 539     slen = strlen ("arm") + 1;
 540     sctx = GNUNET_malloc (sizeof (struct RequestContext) + slen);
 541     sctx->h = h;
 542     sctx->callback = cb;
 543     sctx->cls = cb_cls;
 544     sctx->timeout = GNUNET_TIME_relative_to_absolute (timeout);
 545     sctx->std_inheritance = std_inheritance;
 546     memcpy (&sctx[1], service_name, slen);
 547     GNUNET_CLIENT_service_test ("arm", h->cfg, timeout, &arm_service_report,
 548                                 sctx);
 549     return;
 550   }
 551   if (NULL == h->client)
 552   {
 553     client = GNUNET_CLIENT_connect ("arm", h->cfg);
 554     if (client == NULL)
 555     {
 556       LOG (GNUNET_ERROR_TYPE_DEBUG,
 557            "arm_api, GNUNET_CLIENT_connect returned NULL\n");
 558       cb (cb_cls, GNUNET_ARM_PROCESS_COMMUNICATION_ERROR);
 559       return;
 560     }
 561     LOG (GNUNET_ERROR_TYPE_DEBUG,
 562          "arm_api, GNUNET_CLIENT_connect returned non-NULL\n");
 563     h->client = client;
 564   }
 565   LOG (GNUNET_ERROR_TYPE_DEBUG, "arm_api, h->client non-NULL\n");
 566   change_service (h, service_name, timeout, cb, cb_cls,
 567                   GNUNET_MESSAGE_TYPE_ARM_START);
 568 }
 569
 570
 571 /**
 572  * Callback from the arm stop service call, indicates that the arm service
 573  * is well and truly dead, won't die, or an error occurred.
 574  *
 575  * @param cls closure for the callback
 576  * @param reason reason for callback
 577  */
 578 static void
 579 arm_shutdown_callback (void *cls, enum GNUNET_ARM_ProcessStatus reason)
 580 {
 581   struct ARM_ShutdownContext *arm_shutdown_ctx = cls;
 582
 583   if (arm_shutdown_ctx->cb != NULL)
 584     arm_shutdown_ctx->cb (arm_shutdown_ctx->cb_cls, reason);
 585   GNUNET_free (arm_shutdown_ctx);
 586 }
 587
 588
 589 /**
 590  * Stop a service.
 591  *
 592  * @param h handle to ARM
 593  * @param service_name name of the service
 594  * @param timeout how long to wait before failing for good
 595  * @param cb callback to invoke when service is ready
 596  * @param cb_cls closure for callback
 597  */
 598 void
 599 GNUNET_ARM_stop_service (struct GNUNET_ARM_Handle *h,
 600                          const char *service_name,
 601                          struct GNUNET_TIME_Relative timeout,
 602                          GNUNET_ARM_Callback cb, void *cb_cls)
 603 {
 604   struct ARM_ShutdownContext *arm_shutdown_ctx;
 605   struct GNUNET_CLIENT_Connection *client;
 606
 607   LOG (GNUNET_ERROR_TYPE_DEBUG,
 608        "Stopping service `%s' within %s\n",
 609        service_name,
 610        GNUNET_STRINGS_relative_time_to_string (timeout));
 611   if (h->client == NULL)
 612   {
 613     client = GNUNET_CLIENT_connect ("arm", h->cfg);
 614     if (client == NULL)
 615     {
 616       cb (cb_cls, GNUNET_SYSERR);
 617       return;
 618     }
 619     h->client = client;
 620   }
 621   if (0 == strcasecmp ("arm", service_name))
 622   {
 623     arm_shutdown_ctx = GNUNET_malloc (sizeof (struct ARM_ShutdownContext));
 624     arm_shutdown_ctx->cb = cb;
 625     arm_shutdown_ctx->cb_cls = cb_cls;
 626     arm_service_shutdown (h->client, timeout, &arm_shutdown_callback,
 627                           arm_shutdown_ctx);
 628     h->client = NULL;
 629     return;
 630   }
 631   change_service (h, service_name, timeout, cb, cb_cls,
 632                   GNUNET_MESSAGE_TYPE_ARM_STOP);
 633 }
 634
 635
 636 /**
 637  * Internal state for a list request with ARM.
 638  */
 639 struct ListRequestContext
 640 {
 641
 642   /**
 643    * Pointer to our handle with ARM.
 644    */
 645   struct GNUNET_ARM_Handle *h;
 646
 647   /**
 648    * Function to call with a status code for the requested operation.
 649    */
 650   GNUNET_ARM_List_Callback callback;
 651
 652   /**
 653    * Closure for "callback".
 654    */
 655   void *cls;
 656
 657   /**
 658    * Timeout for the operation.
 659    */
 660   struct GNUNET_TIME_Absolute timeout;
 661 };
 662
 663
 664 /**
 665  * Process a response from ARM for the list request.
 666  *
 667  * @param cls the list request context
 668  * @param msg the response
 669  */
 670 static void
 671 handle_list_response (void *cls, const struct GNUNET_MessageHeader *msg)
 672 {
 673   struct ListRequestContext *sc = cls;
 674   const struct GNUNET_ARM_ListResultMessage *res;
 675   const char *pos;
 676   uint16_t size_check;
 677   uint16_t rcount;
 678   uint16_t msize;
 679
 680   if (NULL == msg)
 681   {
 682     GNUNET_break (0);
 683     GNUNET_CLIENT_disconnect (sc->h->client);
 684     sc->h->client = GNUNET_CLIENT_connect ("arm", sc->h->cfg);
 685     GNUNET_assert (NULL != sc->h->client);
 686     if (sc->callback != NULL)
 687       sc->callback (sc->cls, GNUNET_ARM_PROCESS_COMMUNICATION_ERROR, 0, NULL);
 688     GNUNET_free (sc);
 689     return;
 690   }
 691
 692   if (NULL == sc->callback)
 693   {
 694     GNUNET_break (0);
 695     GNUNET_free (sc);
 696     return;
 697   }
 698   msize = ntohs (msg->size);
 699   if ( (msize < sizeof ( struct GNUNET_ARM_ListResultMessage)) ||
 700        (ntohs (msg->type) != GNUNET_MESSAGE_TYPE_ARM_LIST_RESULT) )
 701   {
 702     GNUNET_break (0);
 703     sc->callback (sc->cls, GNUNET_NO, 0, NULL);
 704     GNUNET_free (sc);
 705     return;
 706   }
 707   size_check = 0;
 708   res = (const struct GNUNET_ARM_ListResultMessage *) msg;
 709   rcount = ntohs (res->count);
 710   {
 711     const char *list[rcount];
 712     unsigned int i;
 713
 714     pos = (const char *)&res[1];
 715     for (i=0; i<rcount; i++)
 716     {
 717       const char *end = memchr (pos, 0, msize - size_check);
 718       if (NULL == end)
 719       {
 720         GNUNET_break (0);
 721         sc->callback (sc->cls, GNUNET_NO, 0, NULL);
 722         GNUNET_free (sc);
 723         return;
 724       }
 725       list[i] = pos;
 726       size_check += (end - pos) + 1;
 727       pos = end + 1;
 728     }
 729     sc->callback (sc->cls, GNUNET_YES, rcount, list);
 730   }
 731   GNUNET_free (sc);
 732 }
 733
 734
 735 /**
 736  * List all running services.
 737  *
 738  * @param h handle to ARM
 739  * @param timeout how long to wait before failing for good
 740  * @param cb callback to invoke when service is ready
 741  * @param cb_cls closure for callback
 742  */
 743 void
 744 GNUNET_ARM_list_running_services (struct GNUNET_ARM_Handle *h,
 745                                   struct GNUNET_TIME_Relative timeout,
 746                                   GNUNET_ARM_List_Callback cb, void *cb_cls)
 747 {
 748   struct ListRequestContext *sctx;
 749   struct GNUNET_MessageHeader msg;
 750   struct GNUNET_CLIENT_Connection *client;
 751
 752   if (h->client == NULL)
 753   {
 754     client = GNUNET_CLIENT_connect ("arm", h->cfg);
 755     if (client == NULL)
 756     {
 757       GNUNET_break (0);
 758       cb (cb_cls, GNUNET_ARM_PROCESS_COMMUNICATION_ERROR, 0, NULL);
 759       return;
 760     }
 761     h->client = client;
 762   }
 763
 764   sctx = GNUNET_malloc (sizeof (struct RequestContext));
 765   sctx->h = h;
 766   sctx->callback = cb;
 767   sctx->cls = cb_cls;
 768   sctx->timeout = GNUNET_TIME_relative_to_absolute (timeout);
 769   msg.size = htons (sizeof (struct GNUNET_MessageHeader));
 770   msg.type = htons (GNUNET_MESSAGE_TYPE_ARM_LIST);
 771
 772   LOG (GNUNET_ERROR_TYPE_DEBUG,
 773        "Requesting LIST from ARM service with timeout: %s\n",
 774        GNUNET_STRINGS_relative_time_to_string (timeout));
 775
 776   if (GNUNET_OK !=
 777       GNUNET_CLIENT_transmit_and_get_response (sctx->h->client,
 778                                                &msg,
 779                                                GNUNET_TIME_absolute_get_remaining
 780                                                (sctx->timeout),
 781                                                GNUNET_YES,
 782                                                &handle_list_response,
 783                                                sctx))
 784   {
 785     GNUNET_break (0);
 786     if (cb != NULL)
 787       cb (cb_cls, GNUNET_SYSERR, 0, NULL);
 788     GNUNET_free (sctx);
 789     return;
 790   }
 791 }
 792
 793 /* end of arm_api.c */