095d60e36ac5b514fba039475dc95ee2870de65f
[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 (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 static const char *
193 req_string (enum GNUNET_ARM_RequestStatus rs)
194 {
195   switch (rs)
196   {
197   case GNUNET_ARM_REQUEST_SENT_OK:
198     return _("Message was sent successfully");
199   case GNUNET_ARM_REQUEST_CONFIGURATION_ERROR:
200     return _("Misconfiguration (can't connect to the ARM service)");
201   case GNUNET_ARM_REQUEST_DISCONNECTED:
202     return _("We disconnected from ARM before we could send a request");
203   case GNUNET_ARM_REQUEST_BUSY:
204     return _("ARM API is busy");
205   case GNUNET_ARM_REQUEST_TOO_LONG:
206     return _("Request doesn't fit into a message");
207   case GNUNET_ARM_REQUEST_TIMEOUT:
208     return _("Request timed out");
209   default:
210     return _("Unknown request status");
211   }
212 }
213
214 static const char *
215 ret_string (enum GNUNET_ARM_Result result)
216 {
217   switch (result)
218   {
219   case GNUNET_ARM_RESULT_STOPPED:
220     return _("%s is stopped");
221   case GNUNET_ARM_RESULT_STARTING:
222     return _("%s is starting");
223   case GNUNET_ARM_RESULT_IS_STARTING_ALREADY:
224     return _("%s is starting already");
225   case GNUNET_ARM_RESULT_IS_STOPPING_ALREADY:
226     return _("%s is stopping already");
227   case GNUNET_ARM_RESULT_IS_STARTED_ALREADY:
228     return _("%s is started already");
229   case GNUNET_ARM_RESULT_IS_STOPPED_ALREADY:
230     return _("%s is stopped already");
231   case GNUNET_ARM_RESULT_IS_NOT_KNOWN:
232     return _("%s service is not known to ARM");
233   case GNUNET_ARM_RESULT_START_FAILED:
234     return _("%s service failed to start");
235   case GNUNET_ARM_RESULT_IN_SHUTDOWN:
236     return _("%s service can't be started because ARM is shutting down");
237   default:
238     return _("Unknown result code.");
239   }
240 }
241
242 static void action_loop (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
243
244 /**
245  * Function called whenever we connect to or disconnect from ARM.
246  *
247  * @param cls closure
248  * @param arm handle to the ARM connection
249  * @param connected GNUNET_YES if connected, GNUNET_NO if disconnected
250  * @param error GNUNET_YES if we encountered a permanent error, and there
251  *              will be no re-connection.
252  */
253 static void
254 conn_status (void *cls, struct GNUNET_ARM_Handle *arm, unsigned char connected, unsigned char error)
255 {
256   if (GNUNET_YES == error)
257   {
258     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
259                 _("Fatal error initializing ARM API.\n"));
260     GNUNET_SCHEDULER_shutdown ();
261     return;
262   }
263 /*
264   if (connected)
265     GNUNET_SCHEDULER_add_now (action_loop, NULL);
266 */
267 }
268
269
270 static void
271 term_callback (void *cls, struct GNUNET_ARM_Handle *arm,
272     enum GNUNET_ARM_RequestStatus rs, const char *service,
273     enum GNUNET_ARM_Result result)
274 {
275   if (GNUNET_ARM_REQUEST_SENT_OK != rs)
276   {
277     char *msg;
278     GNUNET_asprintf (&msg, _("Failed to send a request to kill the `%s' service: %%s\n"), term);
279     FPRINTF (stdout, msg, req_string (rs));
280     GNUNET_free (msg);
281     GNUNET_SCHEDULER_shutdown ();
282   }
283   if ((GNUNET_ARM_RESULT_STOPPED == result) ||
284       (GNUNET_ARM_RESULT_IS_STOPPED_ALREADY == result))
285   {
286     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Service %s shutdown successful\n", term);
287     term = NULL;
288     GNUNET_SCHEDULER_add_now (action_loop, NULL);
289   }
290   else
291   {
292     char *msg;
293     GNUNET_asprintf (&msg, _("Failed to kill the `%s' service: %%s\n"), term);
294     FPRINTF (stdout, msg, ret_string (result));
295     GNUNET_free (msg);
296     GNUNET_SCHEDULER_shutdown ();
297   }
298 }
299
300 static void
301 end_callback (void *cls, struct GNUNET_ARM_Handle *arm,
302     enum GNUNET_ARM_RequestStatus rs, const char *service,
303     enum GNUNET_ARM_Result result)
304 {
305   if (GNUNET_ARM_REQUEST_SENT_OK != rs)
306   {
307     char *msg;
308     GNUNET_asprintf (&msg, "%s", _("Failed to send a stop request to the ARM service: %s\n"));
309     FPRINTF (stdout, msg, req_string (rs));
310     GNUNET_free (msg);
311     GNUNET_SCHEDULER_shutdown ();
312   }
313   if ((GNUNET_ARM_RESULT_STOPPING == result) ||
314       (GNUNET_ARM_RESULT_STOPPED == result) ||
315       (GNUNET_ARM_RESULT_IS_STOPPED_ALREADY == result))
316   {
317     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "ARM service shutdown successful\n");
318     end = 0;
319     if (restart)
320     {
321       restart = 0;
322       start = 1;
323       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Initiating an ARM restart\n");
324     }
325     GNUNET_SCHEDULER_add_now (action_loop, NULL);
326   }
327   else
328   {
329     char *msg;
330     GNUNET_asprintf (&msg, "%s", _("Failed to stop the ARM service: %s\n"));
331     FPRINTF (stdout, msg, ret_string (result));
332     GNUNET_free (msg);
333     GNUNET_SCHEDULER_shutdown ();
334   }
335 }
336
337 static void
338 start_callback (void *cls, struct GNUNET_ARM_Handle *arm,
339     enum GNUNET_ARM_RequestStatus rs, const char *service,
340     enum GNUNET_ARM_Result result)
341 {
342   if (GNUNET_ARM_REQUEST_SENT_OK != rs)
343   {
344     char *msg;
345     GNUNET_asprintf (&msg, "%s", _("Failed to start the ARM service: %s\n"));
346     FPRINTF (stdout, msg, req_string (rs));
347     GNUNET_free (msg);
348     GNUNET_SCHEDULER_shutdown ();
349   }
350   if ((GNUNET_ARM_RESULT_STARTING == result) ||
351       (GNUNET_ARM_RESULT_IS_STARTED_ALREADY == result))
352   {
353     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "ARM service [re]start successful\n");
354     start = 0;
355     GNUNET_SCHEDULER_add_now (action_loop, NULL);
356   }
357   else
358   {
359     char *msg;
360     GNUNET_asprintf (&msg, "%s", _("Failed to start the ARM service: %s\n"));
361     FPRINTF (stdout, msg, ret_string (result));
362     GNUNET_free (msg);
363     GNUNET_SCHEDULER_shutdown ();
364   }
365 }
366
367
368 static void
369 init_callback (void *cls, struct GNUNET_ARM_Handle *arm,
370     enum GNUNET_ARM_RequestStatus rs, const char *service,
371     enum GNUNET_ARM_Result result)
372 {
373   if (GNUNET_ARM_REQUEST_SENT_OK != rs)
374   {
375     char *msg;
376     GNUNET_asprintf (&msg, _("Failed to send a request to start the `%s' service: %%s\n"), init);
377     FPRINTF (stdout, msg, req_string (rs));
378     GNUNET_free (msg);
379     GNUNET_SCHEDULER_shutdown ();
380   }
381   if ((GNUNET_ARM_RESULT_STARTING == result) ||
382       (GNUNET_ARM_RESULT_IS_STARTED_ALREADY == result))
383   {
384     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Service %s [re]start successful\n", init);
385     init = NULL;
386     GNUNET_SCHEDULER_add_now (action_loop, NULL);
387   }
388   else
389   {
390     char *msg;
391     GNUNET_asprintf (&msg, _("Failed to start the `%s' service: %%s\n"), init);
392     FPRINTF (stdout, msg, ret_string (result));
393     GNUNET_free (msg);
394     GNUNET_SCHEDULER_shutdown ();
395   }
396 }
397
398
399 static void
400 list_callback (void *cls, struct GNUNET_ARM_Handle *arm,
401     enum GNUNET_ARM_RequestStatus rs, unsigned int count,
402     const char *const*list)
403 {
404   unsigned int i;
405   if (GNUNET_ARM_REQUEST_SENT_OK != rs)
406   {
407     char *msg;
408     GNUNET_asprintf (&msg, "%s", _("Failed to request a list of services: %s\n"));
409     FPRINTF (stdout, msg, req_string (rs));
410     GNUNET_free (msg);
411     GNUNET_SCHEDULER_shutdown ();
412   }
413   if (NULL == list)
414   {
415     FPRINTF (stderr, "%s", _("Error communicating with ARM. ARM not running?\n"));
416     return;
417   }
418   FPRINTF (stdout, "%s", _("Running services:\n"));
419   for (i = 0; i < count; i++)
420     FPRINTF (stdout, "%s\n", list[i]);
421   GNUNET_SCHEDULER_add_now (action_loop, NULL);
422 }
423
424
425 /**
426  * Main action loop.  Runs the various
427  * jobs that we've been asked to do in order.
428  *
429  * @param cls closure, unused
430  * @param tc context, unused
431  */
432 static void
433 action_loop (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
434 {
435   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Running requested actions\n");
436   if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
437     return;
438   while (1)
439   {
440     switch (phase++)
441     {
442     case 0:
443       if (NULL != term)
444       {
445         GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Termination action\n");
446         GNUNET_ARM_request_service_stop (h, term, (0 ==
447             timeout.rel_value) ? STOP_TIMEOUT : timeout,
448             term_callback, NULL);
449         return;
450       }
451       break;
452     case 1:
453       if (end || restart)
454       {
455         GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "End action\n");
456         GNUNET_ARM_request_service_stop (h, "arm", (0 ==
457             timeout.rel_value) ? STOP_TIMEOUT_ARM : timeout,
458             end_callback, NULL);
459         return;
460       }
461       break;
462     case 2:
463       if (start)
464       {
465         GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Start action\n");
466         GNUNET_ARM_request_service_start (h, "arm",
467             (no_stdout ? 0 : GNUNET_OS_INHERIT_STD_OUT) |
468             (no_stderr ? 0 : GNUNET_OS_INHERIT_STD_ERR),
469             (0 == timeout.rel_value) ? START_TIMEOUT: timeout,
470             start_callback, NULL);
471         return;
472       }
473       break;
474     case 3:
475       if (NULL != init)
476       {
477         GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Initialization action\n");
478         GNUNET_ARM_request_service_start (h, init, GNUNET_OS_INHERIT_STD_NONE,
479             (0 == timeout.rel_value) ? STOP_TIMEOUT : timeout,
480             init_callback, NULL);
481         return;
482       }
483       break;
484     case 4:
485       if (list) 
486       {
487         GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
488                     "Going to list all running services controlled by ARM.\n");
489         
490         GNUNET_ARM_request_service_list (h,
491             (0 == timeout.rel_value) ? LIST_TIMEOUT : timeout,
492             list_callback, &list);
493         return;
494       }
495       /* Fall through */
496     default:            /* last phase */
497       GNUNET_SCHEDULER_shutdown ();
498       return;
499     }
500   }
501 }
502
503
504 /**
505  * Function called when a service starts or stops.
506  *
507  * @param cls closure
508  * @param arm handle to the ARM connection
509  * @param service service name
510  * @param status status of the service
511  */
512 static void
513 srv_status (void *cls, struct GNUNET_ARM_MonitorHandle *arm,
514     const char *service, enum GNUNET_ARM_ServiceStatus status)
515 {
516   const char *msg;
517   switch (status)
518   {
519   case GNUNET_ARM_SERVICE_MONITORING_STARTED:
520     msg = _("Began monitoring ARM for service status changes\n");
521     break;
522   case GNUNET_ARM_SERVICE_STOPPED:
523     msg = _("Stopped %s.\n");
524     break;
525   case GNUNET_ARM_SERVICE_STARTING:
526     msg = _("Starting %s...\n");
527     break;
528   case GNUNET_ARM_SERVICE_STOPPING:
529     msg = _("Stopping %s...\n");
530     break;
531   default:
532     msg = NULL;
533     break;
534   }
535   if (NULL != msg)
536     FPRINTF (stderr, msg, service);
537   else
538     FPRINTF (stderr, _("Unknown status %u for service %s.\n"), status, service);
539   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Got service %s status %u\n", service, status);
540 }
541
542
543 /**
544  * Main function that will be run by the scheduler.
545  *
546  * @param cls closure
547  * @param args remaining command-line arguments
548  * @param cfgfile name of the configuration file used (for saving, can be NULL!)
549  * @param c configuration
550  */
551 static void
552 run (void *cls, char *const *args, const char *cfgfile,
553      const struct GNUNET_CONFIGURATION_Handle *c)
554 {
555   char *armconfig;
556
557   cfg = GNUNET_CONFIGURATION_dup (c);
558   config_file = cfgfile;
559   if (GNUNET_CONFIGURATION_get_value_string
560       (cfg, "PATHS", "SERVICEHOME", &dir) != GNUNET_OK)
561   {
562     GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR,
563                                "PATHS", "SERVICEHOME");
564     return;
565     }
566   if (NULL != cfgfile)
567   {
568     if (GNUNET_OK !=
569         GNUNET_CONFIGURATION_get_value_filename (cfg, "arm", "CONFIG",
570                                                  &armconfig))
571     {
572       GNUNET_CONFIGURATION_set_value_string (cfg, "arm", "CONFIG",
573                                              cfgfile);
574     }
575     else
576       GNUNET_free (armconfig);
577   }
578   h = GNUNET_ARM_alloc (cfg);
579   m = GNUNET_ARM_monitor_alloc (cfg);
580   GNUNET_ARM_connect (h, conn_status, NULL);
581   GNUNET_ARM_monitor (m, srv_status, NULL);
582   GNUNET_SCHEDULER_add_now (action_loop, NULL);
583   GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
584                                 shutdown_task, NULL);
585 }
586
587
588 /**
589  * The main function to obtain arm from gnunetd.
590  *
591  * @param argc number of arguments from the command line
592  * @param argv command line arguments
593  * @return 0 ok, 1 on error
594  */
595 int
596 main (int argc, char *const *argv)
597 {
598   static const struct GNUNET_GETOPT_CommandLineOption options[] = {
599     {'e', "end", NULL, gettext_noop ("stop all GNUnet services"),
600      GNUNET_NO, &GNUNET_GETOPT_set_one, &end},
601     {'i', "init", "SERVICE", gettext_noop ("start a particular service"),
602      GNUNET_YES, &GNUNET_GETOPT_set_string, &init},
603     {'k', "kill", "SERVICE", gettext_noop ("stop a particular service"),
604      GNUNET_YES, &GNUNET_GETOPT_set_string, &term},
605     {'s', "start", NULL, gettext_noop ("start all GNUnet default services"),
606      GNUNET_NO, &GNUNET_GETOPT_set_one, &start},
607     {'r', "restart", NULL,
608      gettext_noop ("stop and start all GNUnet default services"),
609      GNUNET_NO, &GNUNET_GETOPT_set_one, &restart},
610     {'d', "delete", NULL,
611      gettext_noop ("delete config file and directory on exit"),
612      GNUNET_NO, &GNUNET_GETOPT_set_one, &delete},
613     {'q', "quiet", NULL, gettext_noop ("don't print status messages"),
614      GNUNET_NO, &GNUNET_GETOPT_set_one, &quiet},
615     {'T', "timeout", "MSECS",
616      gettext_noop ("timeout in MSECS milliseconds for completing current operation"),
617      GNUNET_YES, &GNUNET_GETOPT_set_relative_time, &timeout},
618     {'I', "info", NULL, gettext_noop ("list currently running services"),
619      GNUNET_NO, &GNUNET_GETOPT_set_one, &list},
620     {'O', "no-stdout", NULL, gettext_noop ("don't let gnunet-service-arm inherit standard output"),
621      GNUNET_NO, &GNUNET_GETOPT_set_one, &no_stdout},
622     {'E', "no-stderr", NULL, gettext_noop ("don't let gnunet-service-arm inherit standard error"),
623      GNUNET_NO, &GNUNET_GETOPT_set_one, &no_stderr},
624     GNUNET_GETOPT_OPTION_END
625   };
626
627   if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
628     return 2;
629
630   if (GNUNET_OK ==
631       GNUNET_PROGRAM_run (argc, argv, "gnunet-arm",
632                           gettext_noop
633                           ("Control services and the Automated Restart Manager (ARM)"),
634                           options, &run, NULL))
635     {
636       GNUNET_free ((void *) argv);
637       return ret;
638     }
639   GNUNET_free ((void*) argv);
640   return 1;
641 }
642
643 /* end of gnunet-arm.c */