aboutsummaryrefslogtreecommitdiff
path: root/src/arm/gnunet-arm.c
blob: db5687dbc8e9a98ca5a9709d1fe4a57649ae3016 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
/*
     This file is part of GNUnet.
     (C) 2009 Christian Grothoff (and other contributing authors)

     GNUnet is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published
     by the Free Software Foundation; either version 3, 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
     General Public License for more details.

     You should have received a copy of the GNU General Public License
     along with GNUnet; see the file COPYING.  If not, write to the
     Free Software Foundation, Inc., 59 Temple Place - Suite 330,
     Boston, MA 02111-1307, USA.
*/

/**
 * @file arm/gnunet-arm.c
 * @brief arm for writing a tool
 * @author Christian Grothoff
 */
#include "platform.h"
#include "gnunet_arm_service.h"
#include "gnunet_client_lib.h"
#include "gnunet_constants.h"
#include "gnunet_getopt_lib.h"
#include "gnunet_program_lib.h"
#include "gnunet_time_lib.h"

/**
 * Timeout for stopping services.  Long to give some services a real chance.
 */
#define STOP_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 1)

/**
 * Timeout for stopping ARM.  Extra-long since ARM needs to stop everyone else.
 */
#define STOP_TIMEOUT_ARM GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 2)

/**
 * Timeout for starting services, very short because of the strange way start works
 * (by checking if running before starting, so really this time is always waited on
 * startup (annoying)).
 */
#define START_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 1)

/**
 * Timeout for starting services, very short because of the strange way start works
 * (by checking if running before starting, so really this time is always waited on
 * startup (annoying)).
 */
#define TEST_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 2)

/**
 * 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;

/**
 * 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 a service to test.
 */
static char *test;

/**
 * Set to the name of the config file used.
 */
static const 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;

/**
 * Our configuration.
 */
const 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;


/**
 * Main continuation-passing-style loop.  Runs the various
 * jobs that we've been asked to do in order.
 *
 * @param cls closure, unused
 * @param tc context, unused
 */
static void
cps_loop (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);


/**
 * Callback invoked with the status of the last operation.  Reports to the
 * user and then runs the next phase in the FSM.
 *
 * @param cls pointer to "const char*" identifying service that was manipulated
 * @param success GNUNET_OK if service is now running, GNUNET_NO if not, GNUNET_SYSERR on error
 */
static void
confirm_cb (void *cls, int success)
{
  const char *service = cls;

  switch (success)
  {
  case GNUNET_OK:
    if (quiet != GNUNET_YES)
      fprintf (stdout, _("Service `%s' has been started.\n"), service);
    if ((phase - 1 != 2) && (phase - 1 != 3))
    {
      if (quiet != GNUNET_YES)
        fprintf (stdout, _("Failed to stop service `%s'!\n"), service);
      ret = 1;
    }
    break;
  case GNUNET_NO:
    if (quiet != GNUNET_YES)
      fprintf (stdout, _("Service `%s' has been stopped.\n"), service);
    if ((phase - 1 != 0) && (phase - 1 != 1))
    {
      if (quiet != GNUNET_YES)
        fprintf (stdout, _("Failed to start service `%s'!\n"), service);
      ret = 1;
    }
    break;
  case GNUNET_SYSERR:
    if (quiet != GNUNET_YES)
      fprintf (stdout, _("Some error communicating with service `%s'.\n"),
               service);
    ret = 1;
    break;
  }

  GNUNET_SCHEDULER_add_continuation (&cps_loop, NULL,
                                     GNUNET_SCHEDULER_REASON_PREREQ_DONE);
}


/**
 * Function called to confirm that a service is running (or that
 * it is not running).
 *
 * @param cls pointer to "const char*" identifying service that was manipulated
 * @param tc reason determines if service is now running
 */
static void
confirm_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
{
  const char *service = cls;

  if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_PREREQ_DONE))
  {
    if (quiet != GNUNET_YES)
      fprintf (stdout, _("Service `%s' is running.\n"), service);
  }
  else
  {
    if (quiet != GNUNET_YES)
      fprintf (stdout, _("Service `%s' is not running.\n"), service);
  }
  GNUNET_SCHEDULER_add_continuation (&cps_loop, NULL,
                                     GNUNET_SCHEDULER_REASON_PREREQ_DONE);
}


/**
 * 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)
{
  cfg = c;
  config_file = cfgfile;
  if (GNUNET_CONFIGURATION_get_value_string (cfg, "PATHS", "SERVICEHOME", &dir)
      != GNUNET_OK)
  {
    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                _
                ("Fatal configuration error: `%s' option in section `%s' missing.\n"),
                "SERVICEHOME", "PATHS");
    return;
  }
  h = GNUNET_ARM_connect (cfg, NULL);
  if (h == NULL)
  {
    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                _("Fatal error initializing ARM API.\n"));
    ret = 1;
    return;
  }
  GNUNET_SCHEDULER_add_continuation (&cps_loop, NULL,
                                     GNUNET_SCHEDULER_REASON_PREREQ_DONE);
}

/**
 * Attempts to delete configuration file and SERVICEHOME
 * 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 (UNLINK (config_file) != 0)
  {
    GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
                _("Failed to remove configuration file %s\n"), config_file);
  }

  if (GNUNET_DISK_directory_remove (dir) != GNUNET_OK)
  {
    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
 * @param tc context, unused
 */
static void
cps_loop (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
{
  while (1)
  {
    switch (phase++)
    {
    case 0:
      if (term != NULL)
      {
        GNUNET_ARM_stop_service (h, term,
                                 (0 ==
                                  timeout.rel_value) ? STOP_TIMEOUT : timeout,
                                 &confirm_cb, term);
        return;
      }
      break;
    case 1:
      if ((end) || (restart))
      {
        GNUNET_ARM_stop_service (h, "arm",
                                 (0 ==
                                  timeout.rel_value) ? STOP_TIMEOUT_ARM :
                                 timeout, &confirm_cb, "arm");
        return;
      }
      break;
    case 2:
      if (start)
      {
        GNUNET_ARM_start_service (h, "arm",
                                  (0 ==
                                   timeout.rel_value) ? START_TIMEOUT : timeout,
                                  &confirm_cb, "arm");
        return;
      }
      break;
    case 3:
      if (init != NULL)
      {
        GNUNET_ARM_start_service (h, init,
                                  (0 ==
                                   timeout.rel_value) ? START_TIMEOUT : timeout,
                                  &confirm_cb, init);
        return;
      }
      break;
    case 4:
      if (test != NULL)
      {
        GNUNET_CLIENT_service_test (test, cfg,
                                    (0 ==
                                     timeout.rel_value) ? TEST_TIMEOUT :
                                    timeout, &confirm_task, test);
        return;
      }
      break;
    case 5:
      if (restart)
      {
        GNUNET_ARM_disconnect (h);
        phase = 0;
        end = 0;
        start = 1;
        restart = 0;
        h = GNUNET_ARM_connect (cfg, NULL);
        if (h == NULL)
        {
          GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                      _("Fatal error initializing ARM API.\n"));
          ret = 1;
          return;
        }
        GNUNET_SCHEDULER_add_now (&cps_loop, NULL);
        return;
      }
      /* Fall through */
    default:                   /* last phase */
      GNUNET_ARM_disconnect (h);
      if ((end == GNUNET_YES) && (delete == GNUNET_YES))
        delete_files ();
      return;
    }
  }
}


/**
 * 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
 */
int
main (int argc, char *const *argv)
{
  static unsigned long long temp_timeout_ms;

  static const struct GNUNET_GETOPT_CommandLineOption options[] = {
    {'e', "end", NULL, gettext_noop ("stop all GNUnet services"),
     GNUNET_NO, &GNUNET_GETOPT_set_one, &end},
    {'i', "init", "SERVICE", gettext_noop ("start a particular service"),
     GNUNET_YES, &GNUNET_GETOPT_set_string, &init},
    {'k', "kill", "SERVICE", gettext_noop ("stop a particular service"),
     GNUNET_YES, &GNUNET_GETOPT_set_string, &term},
    {'s', "start", NULL, gettext_noop ("start all GNUnet default services"),
     GNUNET_NO, &GNUNET_GETOPT_set_one, &start},
    {'r', "restart", NULL,
     gettext_noop ("stop and start all GNUnet default services"),
     GNUNET_NO, &GNUNET_GETOPT_set_one, &restart},
    {'t', "test", "SERVICE",
     gettext_noop ("test if a particular service is running"),
     GNUNET_YES, &GNUNET_GETOPT_set_string, &test},
    {'d', "delete", NULL,
     gettext_noop ("delete config file and directory on exit"),
     GNUNET_NO, &GNUNET_GETOPT_set_one, &delete},
    {'q', "quiet", NULL, gettext_noop ("don't print status messages"),
     GNUNET_NO, &GNUNET_GETOPT_set_one, &quiet},
    {'T', "timeout", NULL,
     gettext_noop ("timeout for completing current operation"),
     GNUNET_YES, &GNUNET_GETOPT_set_ulong, &temp_timeout_ms},
    GNUNET_GETOPT_OPTION_END
  };

  if (temp_timeout_ms > 0)
    timeout.rel_value = temp_timeout_ms;

  if (GNUNET_OK ==
      GNUNET_PROGRAM_run (argc, argv, "gnunet-arm",
                          gettext_noop
                          ("Control services and the Automated Restart Manager (ARM)"),
                          options, &run, NULL))
  {
    return ret;
  }

  return 1;
}

/* end of gnunet-arm.c */