123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824 |
- /*
- This file is part of GNUnet.
- Copyright (C) 2009, 2012, 2013 GNUnet e.V.
- GNUnet is free software: you can redistribute it and/or modify it
- under the terms of the GNU Affero General Public License as published
- by the Free Software Foundation, either version 3 of the License,
- or (at your option) any later version.
- GNUnet is distributed in the hope that it will be useful, but
- WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- Affero General Public License for more details.
- You should have received a copy of the GNU Affero General Public License
- along with this program. If not, see <http://www.gnu.org/licenses/>.
- SPDX-License-Identifier: AGPL3.0-or-later
- */
- /**
- * @file arm/gnunet-arm.c
- * @brief arm for writing a tool
- * @author Christian Grothoff
- */
- #include "platform.h"
- #include "gnunet_arm_service.h"
- #include "gnunet_constants.h"
- #include "gnunet_util_lib.h"
- /**
- * Set if we are to shutdown all services (including ARM).
- */
- static int end;
- /**
- * Set if we are to start default services (including ARM).
- */
- static int start;
- /**
- * Set if we are to stop/start default services (including ARM).
- */
- static int restart;
- /**
- * Set if we should delete configuration and temp directory on exit.
- */
- static int delete;
- /**
- * Set if we should not print status messages.
- */
- static int quiet;
- /**
- * Monitor ARM activity.
- */
- static int monitor;
- /**
- * Set if we should print a list of currently running services.
- */
- static int list;
- /**
- * Set to the name of a service to start.
- */
- static char *init;
- /**
- * Set to the name of a service to kill.
- */
- static char *term;
- /**
- * Set to the name of the config file used.
- */
- static char *config_file;
- /**
- * Set to the directory where runtime files are stored.
- */
- static char *dir;
- /**
- * Final status code.
- */
- static int ret;
- /**
- * Connection with ARM.
- */
- static struct GNUNET_ARM_Handle *h;
- /**
- * Monitor connection with ARM.
- */
- static struct GNUNET_ARM_MonitorHandle *m;
- /**
- * Our configuration.
- */
- static struct GNUNET_CONFIGURATION_Handle *cfg;
- /**
- * Processing stage that we are in. Simple counter.
- */
- static unsigned int phase;
- /**
- * User defined timestamp for completing operations.
- */
- static struct GNUNET_TIME_Relative timeout;
- /**
- * Task to be run on timeout.
- */
- static struct GNUNET_SCHEDULER_Task *timeout_task;
- /**
- * Do we want to give our stdout to gnunet-service-arm?
- */
- static int no_stdout;
- /**
- * Do we want to give our stderr to gnunet-service-arm?
- */
- static int no_stderr;
- /**
- * Handle for the task running the #action_loop().
- */
- static struct GNUNET_SCHEDULER_Task *al_task;
- /**
- * Current operation.
- */
- static struct GNUNET_ARM_Operation *op;
- /**
- * Attempts to delete configuration file and GNUNET_HOME
- * on ARM shutdown provided the end and delete options
- * were specified when gnunet-arm was run.
- */
- static void
- delete_files ()
- {
- GNUNET_log (
- GNUNET_ERROR_TYPE_DEBUG,
- "Will attempt to remove configuration file %s and service directory %s\n",
- config_file,
- dir);
- if (0 != UNLINK (config_file))
- {
- GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
- _ ("Failed to remove configuration file %s\n"),
- config_file);
- }
- if (GNUNET_OK != GNUNET_DISK_directory_remove (dir))
- {
- GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
- _ ("Failed to remove servicehome directory %s\n"),
- dir);
- }
- }
- /**
- * Main continuation-passing-style loop. Runs the various
- * jobs that we've been asked to do in order.
- *
- * @param cls closure, unused
- */
- static void
- shutdown_task (void *cls)
- {
- (void) cls;
- if (NULL != al_task)
- {
- GNUNET_SCHEDULER_cancel (al_task);
- al_task = NULL;
- }
- if (NULL != op)
- {
- GNUNET_ARM_operation_cancel (op);
- op = NULL;
- }
- if (NULL != h)
- {
- GNUNET_ARM_disconnect (h);
- h = NULL;
- }
- if (NULL != m)
- {
- GNUNET_ARM_monitor_stop (m);
- m = NULL;
- }
- if (NULL != timeout_task)
- {
- GNUNET_SCHEDULER_cancel (timeout_task);
- timeout_task = NULL;
- }
- if ((GNUNET_YES == end) && (GNUNET_YES == delete))
- delete_files ();
- GNUNET_CONFIGURATION_destroy (cfg);
- cfg = NULL;
- }
- /**
- * Returns a string interpretation of @a rs
- *
- * @param rs the request status from ARM
- * @return a string interpretation of the request status
- */
- static const char *
- req_string (enum GNUNET_ARM_RequestStatus rs)
- {
- switch (rs)
- {
- case GNUNET_ARM_REQUEST_SENT_OK:
- return _ ("Message was sent successfully");
- case GNUNET_ARM_REQUEST_DISCONNECTED:
- return _ ("We disconnected from ARM before we could send a request");
- }
- return _ ("Unknown request status");
- }
- /**
- * Returns a string interpretation of the @a result
- *
- * @param result the arm result
- * @return a string interpretation
- */
- static const char *
- ret_string (enum GNUNET_ARM_Result result)
- {
- switch (result)
- {
- case GNUNET_ARM_RESULT_STOPPED:
- return _ ("is stopped");
- case GNUNET_ARM_RESULT_STARTING:
- return _ ("is starting");
- case GNUNET_ARM_RESULT_STOPPING:
- return _ ("is stopping");
- case GNUNET_ARM_RESULT_IS_STARTING_ALREADY:
- return _ ("is starting already");
- case GNUNET_ARM_RESULT_IS_STOPPING_ALREADY:
- return _ ("is stopping already");
- case GNUNET_ARM_RESULT_IS_STARTED_ALREADY:
- return _ ("is started already");
- case GNUNET_ARM_RESULT_IS_STOPPED_ALREADY:
- return _ ("is stopped already");
- case GNUNET_ARM_RESULT_IS_NOT_KNOWN:
- return _ ("service is not known to ARM");
- case GNUNET_ARM_RESULT_START_FAILED:
- return _ ("service failed to start");
- case GNUNET_ARM_RESULT_IN_SHUTDOWN:
- return _ ("service cannot be manipulated because ARM is shutting down");
- }
- return _ ("Unknown result code.");
- }
- /**
- * Main task that runs our various operations in order.
- *
- * @param cls closure
- */
- static void
- action_loop (void *cls);
- /**
- * Function called whenever we connect to or disconnect from ARM.
- * Termiantes the process if we fail to connect to the service on
- * our first attempt.
- *
- * @param cls closure
- * @param connected #GNUNET_YES if connected, #GNUNET_NO if disconnected,
- * #GNUNET_SYSERR on error.
- */
- static void
- conn_status (void *cls, int connected)
- {
- static int once;
- (void) cls;
- if ((GNUNET_SYSERR == connected) && (0 == once))
- {
- GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
- _ ("Fatal error initializing ARM API.\n"));
- GNUNET_SCHEDULER_shutdown ();
- return;
- }
- once = 1;
- }
- /**
- * We have requested ARM to be started, this function
- * is called with the result of the operation. Informs the
- * use of the result; on success, we continue with the event
- * loop, on failure we terminate the process.
- *
- * @param cls closure unused
- * @param rs what happened to our request
- * @param result if the request was processed, this is the result
- * according to ARM
- */
- static void
- start_callback (void *cls,
- enum GNUNET_ARM_RequestStatus rs,
- enum GNUNET_ARM_Result result)
- {
- (void) cls;
- op = NULL;
- if (GNUNET_ARM_REQUEST_SENT_OK != rs)
- {
- FPRINTF (stdout,
- _ ("Failed to start the ARM service: %s\n"),
- req_string (rs));
- GNUNET_SCHEDULER_shutdown ();
- return;
- }
- if ((GNUNET_ARM_RESULT_STARTING != result) &&
- (GNUNET_ARM_RESULT_IS_STARTED_ALREADY != result))
- {
- FPRINTF (stdout,
- _ ("Failed to start the ARM service: %s\n"),
- ret_string (result));
- GNUNET_SCHEDULER_shutdown ();
- return;
- }
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "ARM service [re]start successful\n");
- start = 0;
- al_task = GNUNET_SCHEDULER_add_now (&action_loop, NULL);
- }
- /**
- * We have requested ARM to be stopped, this function
- * is called with the result of the operation. Informs the
- * use of the result; on success, we continue with the event
- * loop, on failure we terminate the process.
- *
- * @param cls closure unused
- * @param rs what happened to our request
- * @param result if the request was processed, this is the result
- * according to ARM
- */
- static void
- stop_callback (void *cls,
- enum GNUNET_ARM_RequestStatus rs,
- enum GNUNET_ARM_Result result)
- {
- char *msg;
- (void) cls;
- op = NULL;
- if (GNUNET_ARM_REQUEST_SENT_OK != rs)
- {
- GNUNET_asprintf (&msg,
- "%s",
- _ (
- "Failed to send a stop request to the ARM service: %s\n"));
- FPRINTF (stdout, msg, req_string (rs));
- GNUNET_free (msg);
- GNUNET_SCHEDULER_shutdown ();
- return;
- }
- if ((GNUNET_ARM_RESULT_STOPPING != result) &&
- (GNUNET_ARM_RESULT_STOPPED != result) &&
- (GNUNET_ARM_RESULT_IS_STOPPED_ALREADY != result))
- {
- FPRINTF (stdout,
- _ ("Failed to stop the ARM service: %s\n"),
- ret_string (result));
- GNUNET_SCHEDULER_shutdown ();
- return;
- }
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "ARM service shutdown successful\n");
- end = 0;
- if (restart)
- {
- restart = 0;
- start = 1;
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Initiating an ARM restart\n");
- }
- al_task = GNUNET_SCHEDULER_add_now (&action_loop, NULL);
- }
- /**
- * We have requested a service to be started, this function
- * is called with the result of the operation. Informs the
- * use of the result; on success, we continue with the event
- * loop, on failure we terminate the process.
- *
- * @param cls closure unused
- * @param rs what happened to our request
- * @param result if the request was processed, this is the result
- * according to ARM
- */
- static void
- init_callback (void *cls,
- enum GNUNET_ARM_RequestStatus rs,
- enum GNUNET_ARM_Result result)
- {
- (void) cls;
- op = NULL;
- if (GNUNET_ARM_REQUEST_SENT_OK != rs)
- {
- FPRINTF (stdout,
- _ ("Failed to send a request to start the `%s' service: %s\n"),
- init,
- req_string (rs));
- GNUNET_SCHEDULER_shutdown ();
- return;
- }
- if ((GNUNET_ARM_RESULT_STARTING != result) &&
- (GNUNET_ARM_RESULT_IS_STARTED_ALREADY != result))
- {
- FPRINTF (stdout,
- _ ("Failed to start the `%s' service: %s\n"),
- init,
- ret_string (result));
- GNUNET_SCHEDULER_shutdown ();
- return;
- }
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
- "Service %s [re]started successfully\n",
- init);
- GNUNET_free (init);
- init = NULL;
- al_task = GNUNET_SCHEDULER_add_now (&action_loop, NULL);
- }
- /**
- * We have requested a service to be stopped, this function
- * is called with the result of the operation. Informs the
- * use of the result; on success, we continue with the event
- * loop, on failure we terminate the process.
- *
- * @param cls closure unused
- * @param rs what happened to our request
- * @param result if the request was processed, this is the result
- * according to ARM
- */
- static void
- term_callback (void *cls,
- enum GNUNET_ARM_RequestStatus rs,
- enum GNUNET_ARM_Result result)
- {
- char *msg;
- (void) cls;
- op = NULL;
- if (GNUNET_ARM_REQUEST_SENT_OK != rs)
- {
- GNUNET_asprintf (&msg,
- _ (
- "Failed to send a request to kill the `%s' service: %%s\n"),
- term);
- FPRINTF (stdout, msg, req_string (rs));
- GNUNET_free (msg);
- GNUNET_SCHEDULER_shutdown ();
- return;
- }
- if ((GNUNET_ARM_RESULT_STOPPED != result) &&
- (GNUNET_ARM_RESULT_IS_STOPPED_ALREADY != result))
- {
- FPRINTF (stdout,
- _ ("Failed to kill the `%s' service: %s\n"),
- term,
- ret_string (result));
- GNUNET_SCHEDULER_shutdown ();
- return;
- }
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
- "Service %s stopped successfully\n",
- term);
- GNUNET_free (term);
- term = NULL;
- al_task = GNUNET_SCHEDULER_add_now (&action_loop, NULL);
- }
- /**
- * Function called with the list of running services. Prints
- * the list to stdout, then starts the event loop again.
- * Prints an error message and terminates the process on errors.
- *
- * @param cls closure (unused)
- * @param rs request status (success, failure, etc.)
- * @param count number of services in the list
- * @param list list of services that are running
- */
- static void
- list_callback (void *cls,
- enum GNUNET_ARM_RequestStatus rs,
- unsigned int count,
- const char *const *list)
- {
- (void) cls;
- op = NULL;
- if (GNUNET_ARM_REQUEST_SENT_OK != rs)
- {
- char *msg;
- GNUNET_asprintf (&msg,
- "%s",
- _ ("Failed to request a list of services: %s\n"));
- FPRINTF (stdout, msg, req_string (rs));
- GNUNET_free (msg);
- ret = 3;
- GNUNET_SCHEDULER_shutdown ();
- }
- if (NULL == list)
- {
- FPRINTF (stderr,
- "%s",
- _ ("Error communicating with ARM. ARM not running?\n"));
- GNUNET_SCHEDULER_shutdown ();
- ret = 3;
- return;
- }
- if (! quiet)
- FPRINTF (stdout, "%s", _ ("Running services:\n"));
- for (unsigned int i = 0; i < count; i++)
- FPRINTF (stdout, "%s\n", list[i]);
- al_task = GNUNET_SCHEDULER_add_now (&action_loop, NULL);
- }
- /**
- * Main action loop. Runs the various jobs that we've been asked to
- * do, in order.
- *
- * @param cls closure, unused
- */
- static void
- action_loop (void *cls)
- {
- (void) cls;
- al_task = NULL;
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Running requested actions\n");
- while (1)
- {
- switch (phase++)
- {
- case 0:
- if (NULL != term)
- {
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Termination action\n");
- op = GNUNET_ARM_request_service_stop (h, term, &term_callback, NULL);
- return;
- }
- break;
- case 1:
- if (end || restart)
- {
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "End action\n");
- op = GNUNET_ARM_request_service_stop (h, "arm", &stop_callback, NULL);
- return;
- }
- break;
- case 2:
- if (start)
- {
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Start action\n");
- op =
- GNUNET_ARM_request_service_start (h,
- "arm",
- (no_stdout
- ? 0
- : GNUNET_OS_INHERIT_STD_OUT) |
- (no_stderr
- ? 0
- : GNUNET_OS_INHERIT_STD_ERR),
- &start_callback,
- NULL);
- return;
- }
- break;
- case 3:
- if (NULL != init)
- {
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Initialization action\n");
- op = GNUNET_ARM_request_service_start (h,
- init,
- GNUNET_OS_INHERIT_STD_NONE,
- &init_callback,
- NULL);
- return;
- }
- break;
- case 4:
- if (list)
- {
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
- "Going to list all running services controlled by ARM.\n");
- op = GNUNET_ARM_request_service_list (h, &list_callback, &list);
- return;
- }
- break;
- case 5:
- if (monitor)
- {
- if (! quiet)
- fprintf (stderr, _ ("Now only monitoring, press CTRL-C to stop.\n"));
- quiet =
- 0; /* does not make sense to stay quiet in monitor mode at this time */
- return; /* done with tasks, just monitor */
- }
- break;
- default: /* last phase */
- GNUNET_SCHEDULER_shutdown ();
- return;
- }
- }
- }
- /**
- * Function called when a service starts or stops.
- *
- * @param cls closure
- * @param service service name
- * @param status status of the service
- */
- static void
- srv_status (void *cls,
- const char *service,
- enum GNUNET_ARM_ServiceStatus status)
- {
- const char *msg;
- (void) cls;
- switch (status)
- {
- case GNUNET_ARM_SERVICE_MONITORING_STARTED:
- return; /* this should be done silently */
- case GNUNET_ARM_SERVICE_STOPPED:
- msg = _ ("Stopped %s.\n");
- break;
- case GNUNET_ARM_SERVICE_STARTING:
- msg = _ ("Starting %s...\n");
- break;
- case GNUNET_ARM_SERVICE_STOPPING:
- msg = _ ("Stopping %s...\n");
- break;
- default:
- msg = NULL;
- break;
- }
- if (! quiet)
- {
- if (NULL != msg)
- FPRINTF (stderr, msg, service);
- else
- FPRINTF (stderr,
- _ ("Unknown status %u for service %s.\n"),
- status,
- service);
- }
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
- "Got service %s status %d\n",
- service,
- (int) status);
- }
- /**
- * Task run on timeout (if -T is given).
- */
- static void
- timeout_task_cb (void *cls)
- {
- (void) cls;
- timeout_task = NULL;
- ret = 2;
- GNUNET_SCHEDULER_shutdown ();
- }
- /**
- * Main function that will be run by the scheduler.
- *
- * @param cls closure
- * @param args remaining command-line arguments
- * @param cfgfile name of the configuration file used (for saving, can be NULL!)
- * @param c configuration
- */
- static void
- run (void *cls,
- char *const *args,
- const char *cfgfile,
- const struct GNUNET_CONFIGURATION_Handle *c)
- {
- (void) cls;
- (void) args;
- (void) cfgfile;
- cfg = GNUNET_CONFIGURATION_dup (c);
- if (GNUNET_OK !=
- GNUNET_CONFIGURATION_get_value_string (cfg, "PATHS", "GNUNET_HOME", &dir))
- {
- GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR, "PATHS", "GNUNET_HOME");
- return;
- }
- (void) GNUNET_CONFIGURATION_get_value_filename (cfg,
- "arm",
- "CONFIG",
- &config_file);
- if (NULL == (h = GNUNET_ARM_connect (cfg, &conn_status, NULL)))
- return;
- if (monitor)
- m = GNUNET_ARM_monitor_start (cfg, &srv_status, NULL);
- al_task = GNUNET_SCHEDULER_add_now (&action_loop, NULL);
- GNUNET_SCHEDULER_add_shutdown (&shutdown_task, NULL);
- if (0 != timeout.rel_value_us)
- timeout_task =
- GNUNET_SCHEDULER_add_delayed (timeout, &timeout_task_cb, NULL);
- }
- /**
- * The main function to obtain arm from gnunetd.
- *
- * @param argc number of arguments from the command line
- * @param argv command line arguments
- * @return 0 ok, 1 on error, 2 on timeout
- */
- int
- main (int argc, char *const *argv)
- {
- struct GNUNET_GETOPT_CommandLineOption options[] =
- {GNUNET_GETOPT_option_flag ('e',
- "end",
- gettext_noop ("stop all GNUnet services"),
- &end),
- GNUNET_GETOPT_option_string ('i',
- "init",
- "SERVICE",
- gettext_noop ("start a particular service"),
- &init),
- GNUNET_GETOPT_option_string ('k',
- "kill",
- "SERVICE",
- gettext_noop ("stop a particular service"),
- &term),
- GNUNET_GETOPT_option_flag ('s',
- "start",
- gettext_noop (
- "start all GNUnet default services"),
- &start),
- GNUNET_GETOPT_option_flag ('r',
- "restart",
- gettext_noop (
- "stop and start all GNUnet default services"),
- &restart),
- GNUNET_GETOPT_option_flag ('d',
- "delete",
- gettext_noop (
- "delete config file and directory on exit"),
- &delete),
- GNUNET_GETOPT_option_flag ('m',
- "monitor",
- gettext_noop ("monitor ARM activities"),
- &monitor),
- GNUNET_GETOPT_option_flag ('q',
- "quiet",
- gettext_noop ("don't print status messages"),
- &quiet),
- GNUNET_GETOPT_option_relative_time (
- 'T',
- "timeout",
- "DELAY",
- gettext_noop (
- "exit with error status if operation does not finish after DELAY"),
- &timeout),
- GNUNET_GETOPT_option_flag ('I',
- "info",
- gettext_noop (
- "list currently running services"),
- &list),
- GNUNET_GETOPT_option_flag (
- 'O',
- "no-stdout",
- gettext_noop ("don't let gnunet-service-arm inherit standard output"),
- &no_stdout),
- GNUNET_GETOPT_option_flag (
- 'E',
- "no-stderr",
- gettext_noop ("don't let gnunet-service-arm inherit standard error"),
- &no_stderr),
- GNUNET_GETOPT_OPTION_END};
- int lret;
- if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
- return 2;
- if (GNUNET_OK ==
- (lret = GNUNET_PROGRAM_run (
- argc,
- argv,
- "gnunet-arm",
- gettext_noop (
- "Control services and the Automated Restart Manager (ARM)"),
- options,
- &run,
- NULL)))
- {
- GNUNET_free ((void *) argv);
- return ret;
- }
- GNUNET_free ((void *) argv);
- return lret;
- }
- /* end of gnunet-arm.c */
|