2 This file is part of GNUnet.
3 (C) 2009, 2010 Christian Grothoff (and other contributing authors)
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 2, or (at your
8 option) any later version.
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.
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.
23 * @brief API for accessing the ARM service
24 * @author Christian Grothoff
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"
37 * Handle for interacting with ARM.
39 struct GNUNET_ARM_Handle
43 * Our connection to the ARM service.
45 struct GNUNET_CLIENT_Connection *client;
48 * The configuration that we are using.
50 struct GNUNET_CONFIGURATION_Handle *cfg;
55 struct GNUNET_SCHEDULER_Handle *sched;
61 * Context for handling the shutdown of a service.
63 struct ShutdownContext
66 * Scheduler to be used to call continuation
68 struct GNUNET_SCHEDULER_Handle *sched;
70 * Connection to the service that is being shutdown.
72 struct GNUNET_CLIENT_Connection *sock;
75 * Time allowed for shutdown to happen.
77 struct GNUNET_TIME_Absolute timeout;
80 * Task set up to cancel the shutdown request on timeout.
82 GNUNET_SCHEDULER_TaskIdentifier cancel_task;
85 * Task to call once shutdown complete
87 GNUNET_CLIENT_ShutdownTask cont;
90 * Closure for shutdown continuation
95 * We received a confirmation that the service will shut down.
102 * Handler receiving response to service shutdown requests.
103 * First call with NULL: service misbehaving, or something.
104 * First call with GNUNET_MESSAGE_TYPE_ARM_SHUTDOWN_ACK:
105 * - service will shutdown
106 * Second call with NULL:
107 * - service has now really shut down.
110 * @param msg NULL, indicating socket closure.
113 service_shutdown_handler (void *cls, const struct GNUNET_MessageHeader *msg)
115 struct ShutdownContext *shutdown_ctx = cls;
117 if ((msg == NULL) && (shutdown_ctx->confirmed != GNUNET_YES))
119 /* Means the other side closed the connection and never confirmed a shutdown */
120 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
121 "Service handle shutdown before ACK!\n");
122 if (shutdown_ctx->cont != NULL)
123 shutdown_ctx->cont(shutdown_ctx->cont_cls, GNUNET_SYSERR);
124 GNUNET_SCHEDULER_cancel(shutdown_ctx->sched, shutdown_ctx->cancel_task);
125 GNUNET_CLIENT_disconnect (shutdown_ctx->sock, GNUNET_NO);
126 GNUNET_free(shutdown_ctx);
128 else if ((msg == NULL) && (shutdown_ctx->confirmed == GNUNET_YES))
130 GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
131 "Service shutdown complete.\n");
132 if (shutdown_ctx->cont != NULL)
133 shutdown_ctx->cont(shutdown_ctx->cont_cls, GNUNET_NO);
135 GNUNET_SCHEDULER_cancel(shutdown_ctx->sched, shutdown_ctx->cancel_task);
136 GNUNET_CLIENT_disconnect (shutdown_ctx->sock, GNUNET_NO);
137 GNUNET_free(shutdown_ctx);
141 GNUNET_assert(ntohs(msg->size) == sizeof(struct GNUNET_MessageHeader));
142 switch (ntohs(msg->type))
144 case GNUNET_MESSAGE_TYPE_ARM_SHUTDOWN_ACK:
145 GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
146 "Received confirmation for service shutdown.\n");
147 shutdown_ctx->confirmed = GNUNET_YES;
148 GNUNET_CLIENT_receive (shutdown_ctx->sock,
149 &service_shutdown_handler,
151 GNUNET_TIME_UNIT_FOREVER_REL);
153 default: /* Fall through */
154 GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
155 "Service shutdown refused!\n");
156 if (shutdown_ctx->cont != NULL)
157 shutdown_ctx->cont(shutdown_ctx->cont_cls, GNUNET_YES);
159 GNUNET_SCHEDULER_cancel(shutdown_ctx->sched, shutdown_ctx->cancel_task);
160 GNUNET_CLIENT_disconnect (shutdown_ctx->sock, GNUNET_NO);
161 GNUNET_free(shutdown_ctx);
168 * Shutting down took too long, cancel receive and return error.
171 * @param tc context information (why was this task triggered now)
173 void service_shutdown_cancel (void *cls,
174 const struct GNUNET_SCHEDULER_TaskContext * tc)
176 struct ShutdownContext *shutdown_ctx = cls;
177 GNUNET_log(GNUNET_ERROR_TYPE_WARNING, "service_shutdown_cancel called!\n");
178 shutdown_ctx->cont(shutdown_ctx->cont_cls, GNUNET_SYSERR);
179 GNUNET_CLIENT_disconnect (shutdown_ctx->sock, GNUNET_NO);
180 GNUNET_free(shutdown_ctx);
185 * If possible, write a shutdown message to the target
186 * buffer and destroy the client connection.
188 * @param cls the "struct GNUNET_CLIENT_Connection" to destroy
189 * @param size number of bytes available in buf
190 * @param buf NULL on error, otherwise target buffer
191 * @return number of bytes written to buf
194 write_shutdown (void *cls, size_t size, void *buf)
196 struct GNUNET_MessageHeader *msg;
197 struct ShutdownContext *shutdown_ctx = cls;
199 if (size < sizeof (struct GNUNET_MessageHeader))
201 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
202 _("Failed to transmit shutdown request to client.\n"));
203 shutdown_ctx->cont(shutdown_ctx->cont_cls, GNUNET_SYSERR);
204 GNUNET_CLIENT_disconnect (shutdown_ctx->sock, GNUNET_NO);
205 GNUNET_free(shutdown_ctx);
206 return 0; /* client disconnected */
209 GNUNET_CLIENT_receive (shutdown_ctx->sock,
210 &service_shutdown_handler, shutdown_ctx,
211 GNUNET_TIME_UNIT_FOREVER_REL);
212 shutdown_ctx->cancel_task = GNUNET_SCHEDULER_add_delayed (shutdown_ctx->sched,
213 GNUNET_TIME_absolute_get_remaining(shutdown_ctx->timeout),
214 &service_shutdown_cancel,
216 msg = (struct GNUNET_MessageHeader *) buf;
217 msg->type = htons (GNUNET_MESSAGE_TYPE_ARM_SHUTDOWN);
218 msg->size = htons (sizeof (struct GNUNET_MessageHeader));
219 return sizeof (struct GNUNET_MessageHeader);
224 * Request that the service should shutdown.
225 * Afterwards, the connection will automatically be
226 * disconnected. Hence the "sock" should not
227 * be used by the caller after this call
228 * (calling this function frees "sock" after a while).
230 * @param sched the scheduler to use for calling shutdown continuation
231 * @param sock the socket connected to the service
232 * @param timeout how long to wait before giving up on transmission
233 * @param cont continuation to call once the service is really down
234 * @param cont_cls closure for continuation
238 arm_service_shutdown (struct GNUNET_SCHEDULER_Handle *sched,
239 struct GNUNET_CLIENT_Connection *sock,
240 struct GNUNET_TIME_Relative timeout,
241 GNUNET_CLIENT_ShutdownTask cont,
244 struct ShutdownContext *shutdown_ctx;
245 shutdown_ctx = GNUNET_malloc(sizeof(struct ShutdownContext));
246 shutdown_ctx->sched = sched;
247 shutdown_ctx->cont = cont;
248 shutdown_ctx->cont_cls = cont_cls;
249 shutdown_ctx->sock = sock;
250 shutdown_ctx->timeout = GNUNET_TIME_relative_to_absolute(timeout);
251 GNUNET_CLIENT_notify_transmit_ready (sock,
253 GNUNET_MessageHeader),
256 &write_shutdown, shutdown_ctx);
261 * Setup a context for communicating with ARM. Note that this
262 * can be done even if the ARM service is not yet running.
264 * @param cfg configuration to use (needed to contact ARM;
265 * the ARM service may internally use a different
266 * configuration to determine how to start the service).
267 * @param sched scheduler to use
268 * @param service service that *this* process is implementing/providing, can be NULL
269 * @return context to use for further ARM operations, NULL on error
271 struct GNUNET_ARM_Handle *
272 GNUNET_ARM_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
273 struct GNUNET_SCHEDULER_Handle *sched,
276 struct GNUNET_ARM_Handle *ret;
278 ret = GNUNET_malloc (sizeof (struct GNUNET_ARM_Handle));
279 ret->cfg = GNUNET_CONFIGURATION_dup (cfg);
286 * Disconnect from the ARM service.
288 * @param h the handle that was being used
291 GNUNET_ARM_disconnect (struct GNUNET_ARM_Handle *h)
293 if (h->client != NULL)
294 GNUNET_CLIENT_disconnect (h->client, GNUNET_NO);
295 GNUNET_CONFIGURATION_destroy (h->cfg);
299 struct ARM_ShutdownContext
302 * Callback to call once shutdown complete.
304 GNUNET_ARM_Callback cb;
307 * Closure for callback.
315 * Internal state for a request with ARM.
317 struct RequestContext
321 * Pointer to our handle with ARM.
323 struct GNUNET_ARM_Handle *h;
326 * Function to call with a status code for the requested operation.
328 GNUNET_ARM_Callback callback;
331 * Closure for "callback".
336 * Timeout for the operation.
338 struct GNUNET_TIME_Absolute timeout;
341 * Type of the request expressed as a message type (start or stop).
347 #include "do_start_process.c"
351 * A client specifically requested starting of ARM itself.
352 * This function is called with information about whether
353 * or not ARM is running; if it is, report success. If
354 * it is not, start the ARM process.
356 * @param cls the context for the request that we will report on (struct RequestContext*)
357 * @param tc why were we called (reason says if ARM is running)
360 arm_service_report (void *cls,
361 const struct GNUNET_SCHEDULER_TaskContext *tc)
363 struct RequestContext *pos = cls;
370 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_PREREQ_DONE))
373 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
374 "Looks like `%s' is already running.\n",
375 "gnunet-service-arm");
377 /* arm is running! */
378 if (pos->callback != NULL)
379 pos->callback (pos->cls, GNUNET_YES);
384 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
385 "Looks like `%s' is not running, will start it.\n",
386 "gnunet-service-arm");
388 /* FIXME: should we check that HOSTNAME for 'arm' is localhost? */
391 GNUNET_CONFIGURATION_get_value_string (pos->h->cfg,
392 "arm", "PREFIX", &loprefix))
393 loprefix = GNUNET_strdup ("");
395 GNUNET_CONFIGURATION_get_value_string (pos->h->cfg,
396 "arm", "OPTIONS", &lopostfix))
397 lopostfix = GNUNET_strdup ("");
399 GNUNET_CONFIGURATION_get_value_string (pos->h->cfg,
404 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
405 _("Configuration failes to specify option `%s' in section `%s'!\n"),
408 if (pos->callback != NULL)
409 pos->callback (pos->cls, GNUNET_SYSERR);
411 GNUNET_free (loprefix);
412 GNUNET_free (lopostfix);
416 GNUNET_CONFIGURATION_get_value_filename (pos->h->cfg,
417 "arm", "CONFIG", &config))
419 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
420 _("Configuration fails to specify option `%s' in section `%s'!\n"),
423 if (pos->callback != NULL)
424 pos->callback (pos->cls, GNUNET_SYSERR);
425 GNUNET_free (binary);
427 GNUNET_free (loprefix);
428 GNUNET_free (lopostfix);
431 pid = do_start_process (loprefix,
440 GNUNET_free (binary);
441 GNUNET_free (config);
442 GNUNET_free (loprefix);
443 GNUNET_free (lopostfix);
446 if (pos->callback != NULL)
447 pos->callback (pos->cls, GNUNET_SYSERR);
451 if (pos->callback != NULL)
452 pos->callback (pos->cls, GNUNET_YES);
458 * Process a response from ARM to a request for a change in service
461 * @param cls the request context
462 * @param msg the response
465 handle_response (void *cls, const struct GNUNET_MessageHeader *msg)
467 struct RequestContext *sc = cls;
472 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
473 _("Error receiving response to `%s' request from ARM for service `%s'\n"),
474 (sc->type == GNUNET_MESSAGE_TYPE_ARM_START)
477 (const char*) &sc[1]);
478 GNUNET_CLIENT_disconnect (sc->h->client, GNUNET_NO);
479 sc->h->client = GNUNET_CLIENT_connect (sc->h->sched,
482 GNUNET_assert (NULL != sc->h->client);
483 GNUNET_CLIENT_ignore_shutdown (sc->h->client, GNUNET_YES);
484 if (sc->callback != NULL)
485 sc->callback (sc->cls, GNUNET_SYSERR);
490 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
491 "Received response from ARM for service `%s': %u\n",
492 (const char*) &sc[1],
495 switch (ntohs (msg->type))
497 case GNUNET_MESSAGE_TYPE_ARM_IS_UP:
500 case GNUNET_MESSAGE_TYPE_ARM_IS_DOWN:
503 case GNUNET_MESSAGE_TYPE_ARM_IS_UNKNOWN:
510 if (sc->callback != NULL)
511 sc->callback (sc->cls, ret);
517 * Start or stop a service.
519 * @param h handle to ARM
520 * @param service_name name of the service
521 * @param timeout how long to wait before failing for good
522 * @param cb callback to invoke when service is ready
523 * @param cb_cls closure for callback
524 * @param type type of the request
527 change_service (struct GNUNET_ARM_Handle *h,
528 const char *service_name,
529 struct GNUNET_TIME_Relative timeout,
530 GNUNET_ARM_Callback cb, void *cb_cls, uint16_t type)
532 struct RequestContext *sctx;
534 struct GNUNET_MessageHeader *msg;
536 slen = strlen (service_name) + 1;
537 if (slen + sizeof (struct GNUNET_MessageHeader) >
538 GNUNET_SERVER_MAX_MESSAGE_SIZE)
542 cb (cb_cls, GNUNET_NO);
546 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
547 (type == GNUNET_MESSAGE_TYPE_ARM_START)
548 ? _("Requesting start of service `%s'.\n")
549 : _("Requesting termination of service `%s'.\n"),
552 sctx = GNUNET_malloc (sizeof (struct RequestContext) + slen);
556 sctx->timeout = GNUNET_TIME_relative_to_absolute (timeout);
558 memcpy (&sctx[1], service_name, slen);
559 msg = GNUNET_malloc (sizeof (struct GNUNET_MessageHeader) + slen);
560 msg->size = htons (sizeof (struct GNUNET_MessageHeader) + slen);
561 msg->type = htons (sctx->type);
562 memcpy (&msg[1], service_name, slen);
564 GNUNET_CLIENT_transmit_and_get_response (sctx->h->client,
566 GNUNET_TIME_absolute_get_remaining (sctx->timeout),
571 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
572 (type == GNUNET_MESSAGE_TYPE_ARM_START)
573 ? _("Error while trying to transmit request to start `%s' to ARM\n")
574 : _("Error while trying to transmit request to stop `%s' to ARM\n"),
575 (const char*) &service_name);
577 cb (cb_cls, GNUNET_SYSERR);
589 * @param h handle to ARM
590 * @param service_name name of the service
591 * @param timeout how long to wait before failing for good
592 * @param cb callback to invoke when service is ready
593 * @param cb_cls closure for callback
596 GNUNET_ARM_start_service (struct GNUNET_ARM_Handle *h,
597 const char *service_name,
598 struct GNUNET_TIME_Relative timeout,
599 GNUNET_ARM_Callback cb, void *cb_cls)
601 struct RequestContext *sctx;
602 struct GNUNET_CLIENT_Connection *client;
605 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
606 _("Asked to start service `%s' within %llu ms\n"), service_name,
607 (unsigned long long) timeout.value);
609 if (0 == strcasecmp ("arm", service_name))
611 slen = strlen ("arm") + 1;
612 sctx = GNUNET_malloc (sizeof (struct RequestContext) + slen);
616 sctx->timeout = GNUNET_TIME_relative_to_absolute (timeout);
617 memcpy (&sctx[1], service_name, slen);
618 GNUNET_CLIENT_service_test (h->sched,
620 h->cfg, timeout, &arm_service_report, sctx);
623 if (h->client == NULL)
625 client = GNUNET_CLIENT_connect (h->sched, "arm", h->cfg);
628 cb (cb_cls, GNUNET_SYSERR);
631 GNUNET_CLIENT_ignore_shutdown (client, GNUNET_YES);
634 change_service (h, service_name, timeout, cb, cb_cls, GNUNET_MESSAGE_TYPE_ARM_START);
638 * Callback from the arm stop service call, indicates that the arm service
639 * is well and truly dead, won't die, or an error occurred.
641 * @param cls closure for the callback
642 * @param reason reason for callback, GNUNET_NO if arm is shutdown
643 * GNUNET_YES if arm remains running, and GNUNET_SYSERR on error
645 void arm_shutdown_callback (void *cls,
648 struct ARM_ShutdownContext *arm_shutdown_ctx = cls;
650 if (arm_shutdown_ctx->cb != NULL)
651 arm_shutdown_ctx->cb (arm_shutdown_ctx->cb_cls, reason);
653 GNUNET_free(arm_shutdown_ctx);
660 * @param h handle to ARM
661 * @param service_name name of the service
662 * @param timeout how long to wait before failing for good
663 * @param cb callback to invoke when service is ready
664 * @param cb_cls closure for callback
667 GNUNET_ARM_stop_service (struct GNUNET_ARM_Handle *h,
668 const char *service_name,
669 struct GNUNET_TIME_Relative timeout,
670 GNUNET_ARM_Callback cb, void *cb_cls)
672 struct ARM_ShutdownContext *arm_shutdown_ctx;
673 struct GNUNET_CLIENT_Connection *client;
675 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
676 _("Stopping service `%s' within %llu ms\n"), service_name,
677 (unsigned long long) timeout.value);
678 if (h->client == NULL)
680 client = GNUNET_CLIENT_connect (h->sched, "arm", h->cfg);
683 cb (cb_cls, GNUNET_SYSERR);
686 GNUNET_CLIENT_ignore_shutdown (client, GNUNET_YES);
689 if (0 == strcasecmp ("arm", service_name))
691 arm_shutdown_ctx = GNUNET_malloc(sizeof(struct ARM_ShutdownContext));
692 arm_shutdown_ctx->cb = cb;
693 arm_shutdown_ctx->cb_cls = cb_cls;
694 arm_service_shutdown (h->sched, h->client, timeout, &arm_shutdown_callback, arm_shutdown_ctx);
698 change_service (h, service_name, timeout, cb, cb_cls, GNUNET_MESSAGE_TYPE_ARM_STOP);
702 /* end of arm_api.c */