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