- doc
[oweals/gnunet.git] / src / arm / gnunet-arm.c
1 /*
2      This file is part of GNUnet.
3      (C) 2009, 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/gnunet-arm.c
23  * @brief arm for writing a tool
24  * @author Christian Grothoff
25  */
26 #include "platform.h"
27 #include "gnunet_arm_service.h"
28 #include "gnunet_constants.h"
29 #include "gnunet_util_lib.h"
30
31 /**
32  * Timeout for stopping services.  Long to give some services a real chance.
33  */
34 #define STOP_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 1)
35
36 /**
37  * Timeout for stopping ARM.  Extra-long since ARM needs to stop everyone else.
38  */
39 #define STOP_TIMEOUT_ARM GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 2)
40
41 /**
42  * Timeout for starting services, very short because of the strange way start works
43  * (by checking if running before starting, so really this time is always waited on
44  * startup (annoying)).
45  */
46 #define START_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 1)
47
48 /**
49  * Timeout for listing all running services.
50  */
51 #define LIST_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 2)
52
53 /**
54  * Set if we are to shutdown all services (including ARM).
55  */
56 static int end;
57
58 /**
59  * Set if we are to start default services (including ARM).
60  */
61 static int start;
62
63 /**
64  * Set if we are to stop/start default services (including ARM).
65  */
66 static int restart;
67
68 /**
69  * Set if we should delete configuration and temp directory on exit.
70  */
71 static int delete;
72
73 /**
74  * Set if we should not print status messages.
75  */
76 static int quiet;
77
78 /**
79  * Set if we should print a list of currently running services.
80  */
81 static int list;
82
83 /**
84  * Set to the name of a service to start.
85  */
86 static char *init;
87
88 /**
89  * Set to the name of a service to kill.
90  */
91 static char *term;
92
93 /**
94  * Set to the name of the config file used.
95  */
96 static const char *config_file;
97
98 /**
99  * Set to the directory where runtime files are stored.
100  */
101 static char *dir;
102
103 /**
104  * Final status code.
105  */
106 static int ret;
107
108 /**
109  * Connection with ARM.
110  */
111 static struct GNUNET_ARM_Handle *h;
112
113 /**
114  * Monitor connection with ARM.
115  */
116 static struct GNUNET_ARM_MonitorHandle *m;
117
118 /**
119  * Our configuration.
120  */
121 static struct GNUNET_CONFIGURATION_Handle *cfg;
122
123 /**
124  * Processing stage that we are in.  Simple counter.
125  */
126 static unsigned int phase;
127
128 /**
129  * User defined timestamp for completing operations.
130  */
131 static struct GNUNET_TIME_Relative timeout;
132
133 /**
134  * Do we want to give our stdout to gnunet-service-arm?
135  */
136 static unsigned int no_stdout;
137
138 /**
139  * Do we want to give our stderr to gnunet-service-arm?
140  */
141 static unsigned int no_stderr;
142
143
144 /**
145  * Attempts to delete configuration file and SERVICEHOME
146  * on arm shutdown provided the end and delete options
147  * were specified when gnunet-arm was run.
148  */
149 static void
150 delete_files ()
151 {
152   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
153               "Will attempt to remove configuration file %s and service directory %s\n",
154               config_file, dir);
155
156   if (UNLINK (config_file) != 0)
157     {
158       GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
159                   _("Failed to remove configuration file %s\n"), config_file);
160     }
161
162   if (GNUNET_DISK_directory_remove (dir) != GNUNET_OK)
163     {
164       GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
165                   _("Failed to remove servicehome directory %s\n"), dir);
166
167     }
168 }
169
170
171 /**
172  * Main continuation-passing-style loop.  Runs the various
173  * jobs that we've been asked to do in order.
174  *
175  * @param cls closure, unused
176  * @param tc context, unused
177  */
178 static void
179 shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
180 {
181   GNUNET_ARM_disconnect_and_free (h);
182   GNUNET_ARM_monitor_disconnect_and_free (m);
183   h = NULL;
184   m = NULL;
185   if ((end == GNUNET_YES) && (delete == GNUNET_YES))
186     delete_files ();    
187   GNUNET_CONFIGURATION_destroy (cfg);
188   cfg = NULL;
189 }
190
191
192 /**
193  * Returns a string interpretation of 'rs'
194  *
195  * @param rs the request status from ARM
196  * @return a string interpretation of the request status
197  */
198 static const char *
199 req_string (enum GNUNET_ARM_RequestStatus rs)
200 {
201   switch (rs)
202   {
203   case GNUNET_ARM_REQUEST_SENT_OK:
204     return _("Message was sent successfully");
205   case GNUNET_ARM_REQUEST_CONFIGURATION_ERROR:
206     return _("Misconfiguration (can't connect to the ARM service)");
207   case GNUNET_ARM_REQUEST_DISCONNECTED:
208     return _("We disconnected from ARM before we could send a request");
209   case GNUNET_ARM_REQUEST_BUSY:
210     return _("ARM API is busy");
211   case GNUNET_ARM_REQUEST_TOO_LONG:
212     return _("Request doesn't fit into a message");
213   case GNUNET_ARM_REQUEST_TIMEOUT:
214     return _("Request timed out");
215   }
216   return _("Unknown request status");
217 }
218
219
220 /**
221  * Returns a string interpretation of the 'result'
222  *
223  * @param result the arm result
224  * @return a string interpretation
225  */
226 static const char *
227 ret_string (enum GNUNET_ARM_Result result)
228 {
229   switch (result)
230   {
231   case GNUNET_ARM_RESULT_STOPPED:
232     return _("%s is stopped");
233   case GNUNET_ARM_RESULT_STARTING:
234     return _("%s is starting");
235   case GNUNET_ARM_RESULT_STOPPING:
236     return _("%s is stopping");
237   case GNUNET_ARM_RESULT_IS_STARTING_ALREADY:
238     return _("%s is starting already");
239   case GNUNET_ARM_RESULT_IS_STOPPING_ALREADY:
240     return _("%s is stopping already");
241   case GNUNET_ARM_RESULT_IS_STARTED_ALREADY:
242     return _("%s is started already");
243   case GNUNET_ARM_RESULT_IS_STOPPED_ALREADY:
244     return _("%s is stopped already");
245   case GNUNET_ARM_RESULT_IS_NOT_KNOWN:
246     return _("%s service is not known to ARM");
247   case GNUNET_ARM_RESULT_START_FAILED:
248     return _("%s service failed to start");
249   case GNUNET_ARM_RESULT_IN_SHUTDOWN:
250     return _("%s service can't be started because ARM is shutting down");
251   }
252   return _("%.s Unknown result code.");
253 }
254
255 static void action_loop (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
256
257 /**
258  * Function called whenever we connect to or disconnect from ARM.
259  *
260  * @param cls closure
261  * @param arm handle to the ARM connection
262  * @param connected GNUNET_YES if connected, GNUNET_NO if disconnected,
263  *                  GNUNET_SYSERR on error.
264  */
265 static void
266 conn_status (void *cls, struct GNUNET_ARM_Handle *arm, 
267              int connected)
268 {
269   if (GNUNET_SYSERR == connected)
270   {
271     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
272                 _("Fatal error initializing ARM API.\n"));
273     GNUNET_SCHEDULER_shutdown ();
274     return;
275   }
276 /*
277   if (connected)
278     GNUNET_SCHEDULER_add_now (action_loop, NULL);
279 */
280 }
281
282
283 static void
284 term_callback (void *cls, struct GNUNET_ARM_Handle *arm,
285     enum GNUNET_ARM_RequestStatus rs, const char *service,
286     enum GNUNET_ARM_Result result)
287 {
288   if (GNUNET_ARM_REQUEST_SENT_OK != rs)
289   {
290     char *msg;
291     GNUNET_asprintf (&msg, _("Failed to send a request to kill the `%s' service: %%s\n"), term);
292     FPRINTF (stdout, msg, req_string (rs));
293     GNUNET_free (msg);
294     GNUNET_SCHEDULER_shutdown ();
295   }
296   if ((GNUNET_ARM_RESULT_STOPPED == result) ||
297       (GNUNET_ARM_RESULT_IS_STOPPED_ALREADY == result))
298   {
299     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Service %s shutdown successful\n", term);
300     term = NULL;
301     GNUNET_SCHEDULER_add_now (action_loop, NULL);
302   }
303   else
304   {
305     char *msg;
306     GNUNET_asprintf (&msg, _("Failed to kill the `%s' service: %%s\n"), term);
307     FPRINTF (stdout, msg, ret_string (result));
308     GNUNET_free (msg);
309     GNUNET_SCHEDULER_shutdown ();
310   }
311 }
312
313 static void
314 end_callback (void *cls, struct GNUNET_ARM_Handle *arm,
315     enum GNUNET_ARM_RequestStatus rs, const char *service,
316     enum GNUNET_ARM_Result result)
317 {
318   if (GNUNET_ARM_REQUEST_SENT_OK != rs)
319   {
320     char *msg;
321     GNUNET_asprintf (&msg, "%s", _("Failed to send a stop request to the ARM service: %s\n"));
322     FPRINTF (stdout, msg, req_string (rs));
323     GNUNET_free (msg);
324     GNUNET_SCHEDULER_shutdown ();
325   }
326   if ((GNUNET_ARM_RESULT_STOPPING == result) ||
327       (GNUNET_ARM_RESULT_STOPPED == result) ||
328       (GNUNET_ARM_RESULT_IS_STOPPED_ALREADY == result))
329   {
330     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "ARM service shutdown successful\n");
331     end = 0;
332     if (restart)
333     {
334       restart = 0;
335       start = 1;
336       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Initiating an ARM restart\n");
337     }
338     GNUNET_SCHEDULER_add_now (action_loop, NULL);
339   }
340   else
341   {
342     char *msg;
343     GNUNET_asprintf (&msg, "%s", _("Failed to stop the ARM service: %s\n"));
344     FPRINTF (stdout, msg, ret_string (result));
345     GNUNET_free (msg);
346     GNUNET_SCHEDULER_shutdown ();
347   }
348 }
349
350 static void
351 start_callback (void *cls, struct GNUNET_ARM_Handle *arm,
352     enum GNUNET_ARM_RequestStatus rs, const char *service,
353     enum GNUNET_ARM_Result result)
354 {
355   char *msg;
356
357   if (GNUNET_ARM_REQUEST_SENT_OK != rs)
358   {
359     GNUNET_asprintf (&msg, "%s", _("Failed to start the ARM service: %s\n"));
360     FPRINTF (stdout, msg, req_string (rs));
361     GNUNET_free (msg);
362     GNUNET_SCHEDULER_shutdown ();
363     return;
364   }
365   if (! ((GNUNET_ARM_RESULT_STARTING == result) ||
366          (GNUNET_ARM_RESULT_IS_STARTED_ALREADY == result)) )
367   {
368     GNUNET_asprintf (&msg, "%s", _("Failed to start the ARM service: %s\n"));
369     FPRINTF (stdout, msg, ret_string (result));
370     GNUNET_free (msg);
371     GNUNET_SCHEDULER_shutdown ();
372   }  
373   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "ARM service [re]start successful\n");
374   start = 0;
375   GNUNET_SCHEDULER_add_now (action_loop, NULL);
376   return;
377 }
378
379
380 static void
381 init_callback (void *cls, struct GNUNET_ARM_Handle *arm,
382     enum GNUNET_ARM_RequestStatus rs, const char *service,
383     enum GNUNET_ARM_Result result)
384 {
385   if (GNUNET_ARM_REQUEST_SENT_OK != rs)
386   {
387     char *msg;
388     GNUNET_asprintf (&msg, _("Failed to send a request to start the `%s' service: %%s\n"), init);
389     FPRINTF (stdout, msg, req_string (rs));
390     GNUNET_free (msg);
391     GNUNET_SCHEDULER_shutdown ();
392   }
393   if ((GNUNET_ARM_RESULT_STARTING == result) ||
394       (GNUNET_ARM_RESULT_IS_STARTED_ALREADY == result))
395   {
396     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Service %s [re]start successful\n", init);
397     init = NULL;
398     GNUNET_SCHEDULER_add_now (action_loop, NULL);
399   }
400   else
401   {
402     char *msg;
403     GNUNET_asprintf (&msg, _("Failed to start the `%s' service: %%s\n"), init);
404     FPRINTF (stdout, msg, ret_string (result));
405     GNUNET_free (msg);
406     GNUNET_SCHEDULER_shutdown ();
407   }
408 }
409
410
411 static void
412 list_callback (void *cls, struct GNUNET_ARM_Handle *arm,
413     enum GNUNET_ARM_RequestStatus rs, unsigned int count,
414     const char *const*list)
415 {
416   unsigned int i;
417   if (GNUNET_ARM_REQUEST_SENT_OK != rs)
418   {
419     char *msg;
420     GNUNET_asprintf (&msg, "%s", _("Failed to request a list of services: %s\n"));
421     FPRINTF (stdout, msg, req_string (rs));
422     GNUNET_free (msg);
423     GNUNET_SCHEDULER_shutdown ();
424   }
425   if (NULL == list)
426   {
427     FPRINTF (stderr, "%s", _("Error communicating with ARM. ARM not running?\n"));
428     return;
429   }
430   FPRINTF (stdout, "%s", _("Running services:\n"));
431   for (i = 0; i < count; i++)
432     FPRINTF (stdout, "%s\n", list[i]);
433   GNUNET_SCHEDULER_add_now (action_loop, NULL);
434 }
435
436
437 /**
438  * Main action loop.  Runs the various
439  * jobs that we've been asked to do in order.
440  *
441  * @param cls closure, unused
442  * @param tc context, unused
443  */
444 static void
445 action_loop (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
446 {
447   if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
448     return;
449   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Running requested actions\n");
450   while (1)
451   {
452     switch (phase++)
453     {
454     case 0:
455       if (NULL != term)
456       {
457         GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Termination action\n");
458         GNUNET_ARM_request_service_stop (h, term, (0 ==
459             timeout.rel_value) ? STOP_TIMEOUT : timeout,
460             term_callback, NULL);
461         return;
462       }
463       break;
464     case 1:
465       if (end || restart)
466       {
467         GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "End action\n");
468         GNUNET_ARM_request_service_stop (h, "arm", (0 ==
469             timeout.rel_value) ? STOP_TIMEOUT_ARM : timeout,
470             end_callback, NULL);
471         return;
472       }
473       break;
474     case 2:
475       if (start)
476       {
477         GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Start action\n");
478         GNUNET_ARM_request_service_start (h, "arm",
479             (no_stdout ? 0 : GNUNET_OS_INHERIT_STD_OUT) |
480             (no_stderr ? 0 : GNUNET_OS_INHERIT_STD_ERR),
481             (0 == timeout.rel_value) ? START_TIMEOUT: timeout,
482             start_callback, NULL);
483         return;
484       }
485       break;
486     case 3:
487       if (NULL != init)
488       {
489         GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Initialization action\n");
490         GNUNET_ARM_request_service_start (h, init, GNUNET_OS_INHERIT_STD_NONE,
491             (0 == timeout.rel_value) ? STOP_TIMEOUT : timeout,
492             init_callback, NULL);
493         return;
494       }
495       break;
496     case 4:
497       if (list) 
498       {
499         GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
500                     "Going to list all running services controlled by ARM.\n");
501         
502         GNUNET_ARM_request_service_list (h,
503             (0 == timeout.rel_value) ? LIST_TIMEOUT : timeout,
504             list_callback, &list);
505         return;
506       }
507       /* Fall through */
508     default:            /* last phase */
509       GNUNET_SCHEDULER_shutdown ();
510       return;
511     }
512   }
513 }
514
515
516 /**
517  * Function called when a service starts or stops.
518  *
519  * @param cls closure
520  * @param arm handle to the ARM connection
521  * @param service service name
522  * @param status status of the service
523  */
524 static void
525 srv_status (void *cls, struct GNUNET_ARM_MonitorHandle *arm,
526     const char *service, enum GNUNET_ARM_ServiceStatus status)
527 {
528   const char *msg;
529   switch (status)
530   {
531   case GNUNET_ARM_SERVICE_MONITORING_STARTED:
532     msg = _("Began monitoring ARM for service status changes\n");
533     break;
534   case GNUNET_ARM_SERVICE_STOPPED:
535     msg = _("Stopped %s.\n");
536     break;
537   case GNUNET_ARM_SERVICE_STARTING:
538     msg = _("Starting %s...\n");
539     break;
540   case GNUNET_ARM_SERVICE_STOPPING:
541     msg = _("Stopping %s...\n");
542     break;
543   default:
544     msg = NULL;
545     break;
546   }
547   if (NULL != msg)
548     FPRINTF (stderr, msg, service);
549   else
550     FPRINTF (stderr, _("Unknown status %u for service %s.\n"), status, service);
551   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Got service %s status %u\n", service, status);
552 }
553
554
555 /**
556  * Main function that will be run by the scheduler.
557  *
558  * @param cls closure
559  * @param args remaining command-line arguments
560  * @param cfgfile name of the configuration file used (for saving, can be NULL!)
561  * @param c configuration
562  */
563 static void
564 run (void *cls, char *const *args, const char *cfgfile,
565      const struct GNUNET_CONFIGURATION_Handle *c)
566 {
567   char *armconfig;
568
569   cfg = GNUNET_CONFIGURATION_dup (c);
570   config_file = cfgfile;
571   if (GNUNET_CONFIGURATION_get_value_string
572       (cfg, "PATHS", "SERVICEHOME", &dir) != GNUNET_OK)
573   {
574     GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR,
575                                "PATHS", "SERVICEHOME");
576     return;
577     }
578   if (NULL != cfgfile)
579   {
580     if (GNUNET_OK !=
581         GNUNET_CONFIGURATION_get_value_filename (cfg, "arm", "CONFIG",
582                                                  &armconfig))
583     {
584       GNUNET_CONFIGURATION_set_value_string (cfg, "arm", "CONFIG",
585                                              cfgfile);
586     }
587     else
588       GNUNET_free (armconfig);
589   }
590   h = GNUNET_ARM_connect (cfg, &conn_status, NULL);
591   if (NULL != h)
592   {
593     m = GNUNET_ARM_monitor (cfg, &srv_status, NULL);
594     if (NULL != m)
595     {
596       GNUNET_SCHEDULER_add_now (&action_loop, NULL);
597       GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
598           shutdown_task, NULL);
599     }
600     else
601     {
602       GNUNET_ARM_disconnect_and_free (h);
603       h = NULL;
604     }
605   }
606 }
607
608
609 /**
610  * The main function to obtain arm from gnunetd.
611  *
612  * @param argc number of arguments from the command line
613  * @param argv command line arguments
614  * @return 0 ok, 1 on error
615  */
616 int
617 main (int argc, char *const *argv)
618 {
619   static const struct GNUNET_GETOPT_CommandLineOption options[] = {
620     {'e', "end", NULL, gettext_noop ("stop all GNUnet services"),
621      GNUNET_NO, &GNUNET_GETOPT_set_one, &end},
622     {'i', "init", "SERVICE", gettext_noop ("start a particular service"),
623      GNUNET_YES, &GNUNET_GETOPT_set_string, &init},
624     {'k', "kill", "SERVICE", gettext_noop ("stop a particular service"),
625      GNUNET_YES, &GNUNET_GETOPT_set_string, &term},
626     {'s', "start", NULL, gettext_noop ("start all GNUnet default services"),
627      GNUNET_NO, &GNUNET_GETOPT_set_one, &start},
628     {'r', "restart", NULL,
629      gettext_noop ("stop and start all GNUnet default services"),
630      GNUNET_NO, &GNUNET_GETOPT_set_one, &restart},
631     {'d', "delete", NULL,
632      gettext_noop ("delete config file and directory on exit"),
633      GNUNET_NO, &GNUNET_GETOPT_set_one, &delete},
634     {'q', "quiet", NULL, gettext_noop ("don't print status messages"),
635      GNUNET_NO, &GNUNET_GETOPT_set_one, &quiet},
636     {'T', "timeout", "MSECS",
637      gettext_noop ("timeout in MSECS milliseconds for completing current operation"),
638      GNUNET_YES, &GNUNET_GETOPT_set_relative_time, &timeout},
639     {'I', "info", NULL, gettext_noop ("list currently running services"),
640      GNUNET_NO, &GNUNET_GETOPT_set_one, &list},
641     {'O', "no-stdout", NULL, gettext_noop ("don't let gnunet-service-arm inherit standard output"),
642      GNUNET_NO, &GNUNET_GETOPT_set_one, &no_stdout},
643     {'E', "no-stderr", NULL, gettext_noop ("don't let gnunet-service-arm inherit standard error"),
644      GNUNET_NO, &GNUNET_GETOPT_set_one, &no_stderr},
645     GNUNET_GETOPT_OPTION_END
646   };
647
648   if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
649     return 2;
650
651   if (GNUNET_OK ==
652       GNUNET_PROGRAM_run (argc, argv, "gnunet-arm",
653                           gettext_noop
654                           ("Control services and the Automated Restart Manager (ARM)"),
655                           options, &run, NULL))
656     {
657       GNUNET_free ((void *) argv);
658       return ret;
659     }
660   GNUNET_free ((void*) argv);
661   return 1;
662 }
663
664 /* end of gnunet-arm.c */