2 This file is part of GNUnet.
3 (C) 2009 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 3, 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.
22 * @file arm/gnunet-arm.c
23 * @brief arm for writing a tool
24 * @author Christian Grothoff
27 #include "gnunet_arm_service.h"
28 #include "gnunet_client_lib.h"
29 #include "gnunet_constants.h"
30 #include "gnunet_getopt_lib.h"
31 #include "gnunet_program_lib.h"
32 #include "gnunet_time_lib.h"
35 * Timeout for stopping services. Long to give some services a real chance.
37 #define STOP_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 1)
40 * Timeout for stopping ARM. Extra-long since ARM needs to stop everyone else.
42 #define STOP_TIMEOUT_ARM GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 2)
45 * Timeout for starting services, very short because of the strange way start works
46 * (by checking if running before starting, so really this time is always waited on
47 * startup (annoying)).
49 #define START_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 1)
52 * Set if we are to shutdown all services (including ARM).
57 * Set if we are to start default services (including ARM).
62 * Set if we are to stop/start default services (including ARM).
67 * Set if we should delete configuration and temp directory on exit.
72 * Set if we should not print status messages.
77 * Set to the name of a service to start.
82 * Set to the name of a service to kill.
87 * Set to the name of the config file used.
89 static const char *config_file;
92 * Set to the directory where runtime files are stored.
102 * Connection with ARM.
104 static struct GNUNET_ARM_Handle *h;
109 static const struct GNUNET_CONFIGURATION_Handle *cfg;
112 * Processing stage that we are in. Simple counter.
114 static unsigned int phase;
117 * User defined timestamp for completing operations.
119 static struct GNUNET_TIME_Relative timeout;
123 * Main continuation-passing-style loop. Runs the various
124 * jobs that we've been asked to do in order.
126 * @param cls closure, unused
127 * @param tc context, unused
130 cps_loop (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
134 * Callback invoked with the status of the last operation. Reports to the
135 * user and then runs the next phase in the FSM.
137 * @param cls pointer to "const char*" identifying service that was manipulated
138 * @param result result of the operation
141 confirm_cb (void *cls,
142 enum GNUNET_ARM_ProcessStatus result)
144 const char *service = cls;
148 case GNUNET_ARM_PROCESS_UNKNOWN:
149 fprintf (stderr, _("Service `%s' is unknown to ARM.\n"), service);
152 case GNUNET_ARM_PROCESS_DOWN:
153 if (quiet != GNUNET_YES)
154 fprintf (stdout, _("Service `%s' has been stopped.\n"), service);
156 case GNUNET_ARM_PROCESS_ALREADY_RUNNING:
157 fprintf (stderr, _("Service `%s' was already running.\n"), service);
160 case GNUNET_ARM_PROCESS_STARTING:
161 if (quiet != GNUNET_YES)
162 fprintf (stdout, _("Service `%s' has been started.\n"), service);
164 case GNUNET_ARM_PROCESS_ALREADY_STOPPING:
165 fprintf (stderr, _("Service `%s' was already being stopped.\n"), service);
168 case GNUNET_ARM_PROCESS_ALREADY_DOWN:
169 fprintf (stderr, _("Service `%s' was already not running.\n"), service);
172 case GNUNET_ARM_PROCESS_SHUTDOWN:
173 fprintf (stderr, _("Request ignored as ARM is shutting down.\n"));
176 case GNUNET_ARM_PROCESS_COMMUNICATION_ERROR:
177 fprintf (stderr, _("Error communicating with ARM service.\n"));
180 case GNUNET_ARM_PROCESS_COMMUNICATION_TIMEOUT:
181 fprintf (stderr, _("Timeout communicating with ARM service.\n"));
184 case GNUNET_ARM_PROCESS_FAILURE:
185 fprintf (stderr, _("Operation failed.\n"));
189 fprintf (stderr, _("Unknown response code from ARM.\n"));
192 GNUNET_SCHEDULER_add_continuation (&cps_loop, NULL,
193 GNUNET_SCHEDULER_REASON_PREREQ_DONE);
198 * Main function that will be run by the scheduler.
201 * @param args remaining command-line arguments
202 * @param cfgfile name of the configuration file used (for saving, can be NULL!)
203 * @param c configuration
206 run (void *cls, char *const *args, const char *cfgfile,
207 const struct GNUNET_CONFIGURATION_Handle *c)
210 config_file = cfgfile;
211 if (GNUNET_CONFIGURATION_get_value_string
212 (cfg, "PATHS", "SERVICEHOME", &dir) != GNUNET_OK)
214 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
216 ("Fatal configuration error: `%s' option in section `%s' missing.\n"),
217 "SERVICEHOME", "PATHS");
220 h = GNUNET_ARM_connect (cfg, NULL);
223 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
224 _("Fatal error initializing ARM API.\n"));
228 GNUNET_SCHEDULER_add_continuation (&cps_loop, NULL,
229 GNUNET_SCHEDULER_REASON_PREREQ_DONE);
233 * Attempts to delete configuration file and SERVICEHOME
234 * on arm shutdown provided the end and delete options
235 * were specified when gnunet-arm was run.
240 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
241 "Will attempt to remove configuration file %s and service directory %s\n",
244 if (UNLINK (config_file) != 0)
246 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
247 _("Failed to remove configuration file %s\n"), config_file);
250 if (GNUNET_DISK_directory_remove (dir) != GNUNET_OK)
252 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
253 _("Failed to remove servicehome directory %s\n"), dir);
259 * Main continuation-passing-style loop. Runs the various
260 * jobs that we've been asked to do in order.
262 * @param cls closure, unused
263 * @param tc context, unused
266 cps_loop (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
275 GNUNET_ARM_stop_service (h, term,
277 timeout.rel_value) ? STOP_TIMEOUT :
278 timeout, &confirm_cb, term);
283 if ((end) || (restart))
285 GNUNET_ARM_stop_service (h, "arm",
287 timeout.rel_value) ? STOP_TIMEOUT_ARM
288 : timeout, &confirm_cb, "arm");
295 GNUNET_ARM_start_service (h, "arm",
297 timeout.rel_value) ? START_TIMEOUT :
298 timeout, &confirm_cb, "arm");
305 GNUNET_ARM_start_service (h, init,
307 timeout.rel_value) ? START_TIMEOUT :
308 timeout, &confirm_cb, init);
315 GNUNET_ARM_disconnect (h);
320 h = GNUNET_ARM_connect (cfg, NULL);
323 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
324 _("Fatal error initializing ARM API.\n"));
328 GNUNET_SCHEDULER_add_now (&cps_loop, NULL);
332 default: /* last phase */
333 GNUNET_ARM_disconnect (h);
334 if ((end == GNUNET_YES) && (delete == GNUNET_YES))
343 * The main function to obtain arm from gnunetd.
345 * @param argc number of arguments from the command line
346 * @param argv command line arguments
347 * @return 0 ok, 1 on error
350 main (int argc, char *const *argv)
352 static unsigned long long temp_timeout_ms;
354 static const struct GNUNET_GETOPT_CommandLineOption options[] = {
355 {'e', "end", NULL, gettext_noop ("stop all GNUnet services"),
356 GNUNET_NO, &GNUNET_GETOPT_set_one, &end},
357 {'i', "init", "SERVICE", gettext_noop ("start a particular service"),
358 GNUNET_YES, &GNUNET_GETOPT_set_string, &init},
359 {'k', "kill", "SERVICE", gettext_noop ("stop a particular service"),
360 GNUNET_YES, &GNUNET_GETOPT_set_string, &term},
361 {'s', "start", NULL, gettext_noop ("start all GNUnet default services"),
362 GNUNET_NO, &GNUNET_GETOPT_set_one, &start},
363 {'r', "restart", NULL,
364 gettext_noop ("stop and start all GNUnet default services"),
365 GNUNET_NO, &GNUNET_GETOPT_set_one, &restart},
366 {'d', "delete", NULL,
367 gettext_noop ("delete config file and directory on exit"),
368 GNUNET_NO, &GNUNET_GETOPT_set_one, &delete},
369 {'q', "quiet", NULL, gettext_noop ("don't print status messages"),
370 GNUNET_NO, &GNUNET_GETOPT_set_one, &quiet},
371 {'T', "timeout", NULL,
372 gettext_noop ("timeout for completing current operation"),
373 GNUNET_YES, &GNUNET_GETOPT_set_ulong, &temp_timeout_ms},
374 GNUNET_GETOPT_OPTION_END
377 if (temp_timeout_ms > 0)
378 timeout.rel_value = temp_timeout_ms;
381 GNUNET_PROGRAM_run (argc, argv, "gnunet-arm",
383 ("Control services and the Automated Restart Manager (ARM)"),
384 options, &run, NULL))
392 /* end of gnunet-arm.c */