summaryrefslogtreecommitdiff
path: root/src/sensor/gnunet-sensor-profiler.c
blob: 9f4682b70206e85e5b15729abcee5c7a04a80b34 (plain)
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
/*
     This file is part of GNUnet.
     (C)

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

/**
 * TODO:
 * - Run X peers
 * - Rewrite interval time (optional)
 * - Run 1 dashboard
 * - Monitor dashboard records
 * - Prompt for anomalies when ready:
 *  -- Cut Y peers (remove their connections to other X-Y peers but not the connections among themselves)
 */

/**
 * @file sensor/gnunet-sensor-profiler.c
 * @brief Profiler for the sensor service
 * @author Omar Tarabai
 */
#include "platform.h"
#include "gnunet_util_lib.h"
#include "gnunet_testbed_service.h"

/**
 * Information about a single peer
 */
struct PeerInfo
{

  /**
   * Peer Identity
   */
  struct GNUNET_PeerIdentity peer_id;

  /**
   * Testbed peer handle
   */
  struct GNUNET_TESTBED_Peer *testbed_peer;

};


/**
 * Name of the configuration file used
 */
static const char *cfg_filename = "gnunet-sensor-profiler.conf";

/**
 * Directory to read sensor definitions from
 */
static const char *sensor_src_dir = "sensors";

/**
 * Directory to write new sensor definitions to
 */
static const char *sensor_dst_dir = "/tmp/gnunet-sensor-profiler";

/**
 * Return value of the program
 */
static int ok = 1;

/**
 * Number of peers to run (Option -p)
 */
static unsigned int num_peers = 0;

/**
 * Set sensors running interval to this value (Option -i)
 */
static unsigned int sensors_interval = 0;

/**
 * Array of peer info for all peers
 */
static struct PeerInfo *all_peers_info;

/**
 * Number of peers that we already collected and start their info
 */
static int peers_known = 0;


/**
 * Copy directory recursively
 *
 * @param src Path to source directory
 * @param dst Destination directory, will be created if it does not exist
 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
 */
static int
copy_dir (const char *src, const char *dst);


/**
 * Do clean up and shutdown scheduler
 */
static void
do_shutdown ()                  // TODO: schedule timeout shutdown
{
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Shutting down.\n");
  if (NULL != all_peers_info)
  {
    GNUNET_free (all_peers_info);
    all_peers_info = NULL;
  }
  GNUNET_SCHEDULER_shutdown ();
}


/**
 * Function called with each file/folder inside a directory that is being copied.
 *
 * @param cls closure, destination directory
 * @param filename complete filename (absolute path)
 * @return #GNUNET_OK to continue to iterate.
 *         #GNUNET_SYSERR to abort iteration with error
 */
static int
copy_dir_scanner (void *cls, const char *filename)
{
  char *dst_dir = cls;
  char *dst;
  int copy_result;

  GNUNET_asprintf (&dst, "%s%s%s", dst_dir, DIR_SEPARATOR_STR,
                   GNUNET_STRINGS_get_short_name (filename));
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Copying `%s' to `%s'.\n", filename,
              dst);
  if (GNUNET_YES == GNUNET_DISK_directory_test (filename, GNUNET_YES))
    copy_result = copy_dir (filename, dst);
  else
  {
    if (GNUNET_YES == GNUNET_DISK_file_test (dst))
      GNUNET_DISK_directory_remove (dst);
    copy_result = GNUNET_DISK_file_copy (filename, dst);
  }
  GNUNET_free (dst);
  return copy_result;
}


/**
 * Copy directory recursively
 *
 * @param src Path to source directory
 * @param dst Destination directory, will be created if it does not exist
 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
 */
static int
copy_dir (const char *src, const char *dst)
{
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Copying directory `%s' to `%s'.\n", src,
              dst);
  if (GNUNET_YES != GNUNET_DISK_directory_test (src, GNUNET_YES))
    return GNUNET_SYSERR;
  if (GNUNET_OK != GNUNET_DISK_directory_create (dst))
    return GNUNET_SYSERR;
  if (GNUNET_SYSERR ==
      GNUNET_DISK_directory_scan (src, &copy_dir_scanner, (char *) dst))
    return GNUNET_SYSERR;
  return GNUNET_OK;
}


/**
 * Function called with each file/folder inside source sensor directory.
 *
 * @param cls closure (unused)
 * @param filename complete filename (absolute path)
 * @return #GNUNET_OK to continue to iterate.
 */
static int
sensor_dir_scanner (void *cls, const char *filename)
{
  const char *file_basename;
  char *dst_path;
  struct GNUNET_CONFIGURATION_Handle *sensor_cfg;

  file_basename = GNUNET_STRINGS_get_short_name (filename);
  GNUNET_asprintf (&dst_path, "%s%s%s", sensor_dst_dir, DIR_SEPARATOR_STR,
                   file_basename);
  if (GNUNET_YES == GNUNET_DISK_directory_test (filename, GNUNET_NO))
  {
    GNUNET_assert (GNUNET_OK == copy_dir (filename, dst_path));
  }
  else
  {
    sensor_cfg = GNUNET_CONFIGURATION_create ();
    GNUNET_assert (GNUNET_OK ==
                   GNUNET_CONFIGURATION_parse (sensor_cfg, filename));
    GNUNET_CONFIGURATION_set_value_string (sensor_cfg, file_basename,
                                           "COLLECTION_POINT",
                                           GNUNET_i2s_full (&all_peers_info[0].
                                                            peer_id));
    if (sensors_interval > 0)
    {
      GNUNET_CONFIGURATION_set_value_number (sensor_cfg, file_basename,
                                             "INTERVAL",
                                             (unsigned long long int)
                                             sensors_interval);
    }
    GNUNET_CONFIGURATION_write (sensor_cfg, dst_path);
    GNUNET_CONFIGURATION_destroy (sensor_cfg);
  }
  GNUNET_free (dst_path);
  return GNUNET_OK;
}


/**
 * Load sensor definitions and rewrite them to tmp location.
 * Add collection point peer id and change running interval if needed.
 */
static void
rewrite_sensors ()
{
  GNUNET_assert (GNUNET_YES ==
                 GNUNET_DISK_directory_test (sensor_src_dir, GNUNET_YES));
  GNUNET_assert (GNUNET_OK == GNUNET_DISK_directory_create (sensor_dst_dir));
  GNUNET_DISK_directory_scan (sensor_src_dir, &sensor_dir_scanner, NULL);
}


/**
 * Callback to be called when dashboard service is started
 *
 * @param cls the callback closure from functions generating an operation
 * @param op the operation that has been finished
 * @param emsg error message in case the operation has failed; will be NULL if
 *          operation has executed successfully.
 */
static void
dashboard_started (void *cls, struct GNUNET_TESTBED_Operation *op,
                   const char *emsg)
{
  if (NULL != emsg)
  {
    GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "ERROR: %s.\n", emsg);
    GNUNET_assert (0);
  }
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Dashboard service started.\n");
  //TODO:
  GNUNET_TESTBED_operation_done (op);
}


/**
 * Callback to be called when the requested peer information is available
 *
 * @param cb_cls the closure from GNUNET_TETSBED_peer_get_information()
 * @param op the operation this callback corresponds to
 * @param pinfo the result; will be NULL if the operation has failed
 * @param emsg error message if the operation has failed; will be NULL if the
 *          operation is successfull
 */
static void
peer_info_cb (void *cb_cls, struct GNUNET_TESTBED_Operation *op,
              const struct GNUNET_TESTBED_PeerInformation *pinfo,
              const char *emsg)
{
  struct GNUNET_TESTBED_Peer *testbed_peer = cb_cls;
  struct PeerInfo *peer = &all_peers_info[peers_known];

  peer->testbed_peer = testbed_peer;
  GNUNET_CRYPTO_get_peer_identity (pinfo->result.cfg, &peer->peer_id);
  if (0 == peers_known)         /* First peer is collection point */
  {
    /* Rewrite sensors */
    rewrite_sensors ();
    /* Start dashboard */
    GNUNET_TESTBED_peer_manage_service (NULL, testbed_peer, "sensordashboard",
                                        &dashboard_started, NULL, 1);
  }
  peers_known++;
  GNUNET_TESTBED_operation_done (op);
}


/**
 * Signature of a main function for a testcase.
 *
 * @param cls closure
 * @param h the run handle
 * @param num number of peers in 'peers'
 * @param peers handle to peers run in the testbed.  NULL upon timeout (see
 *          GNUNET_TESTBED_test_run()).
 * @param links_succeeded the number of overlay link connection attempts that
 *          succeeded
 * @param links_failed the number of overlay link connection attempts that
 *          failed
 * @see GNUNET_TESTBED_test_run()
 */
static void
test_master (void *cls, struct GNUNET_TESTBED_RunHandle *h, unsigned int num,
             struct GNUNET_TESTBED_Peer **peers, unsigned int links_succeeded,
             unsigned int links_failed)
{
  int i;

  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
              "%d peers started. %d links succeeded. %d links failed.\n",
              num_peers, links_succeeded, links_failed);
  GNUNET_assert (num == num_peers);
  GNUNET_assert (0 == links_failed);
  /* Collect peer information */
  all_peers_info = GNUNET_new_array (num_peers, struct PeerInfo);

  for (i = 0; i < num_peers; i++)
  {
    GNUNET_TESTBED_peer_get_information (peers[i],
                                         GNUNET_TESTBED_PIT_CONFIGURATION,
                                         &peer_info_cb, peers[i]);
  }
}


/**
 * Verify that the user passed correct CL args
 *
 * @return #GNUNET_OK if arguments are valid, #GNUNET_SYSERR otherwise
 */
static int
verify_args ()
{
  if (num_peers < 3)
  {
    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                _
                ("Invalid or missing number of peers. Set at least 3 peers.\n"));
    return GNUNET_SYSERR;
  }
  return GNUNET_OK;
}


/**
 * Actual main function.
 *
 * @param cls unused
 * @param args remaining args, unused
 * @param cfgfile name of the configuration
 * @param cfg configuration handle
 */
static void
run (void *cls, char *const *args, const char *cf,
     const struct GNUNET_CONFIGURATION_Handle *c)
{
  struct GNUNET_CONFIGURATION_Handle *cfg;
  double links;

  if (GNUNET_OK != verify_args ())
  {
    do_shutdown ();
    return;
  }
  cfg = GNUNET_CONFIGURATION_create ();
  GNUNET_assert (GNUNET_OK == GNUNET_CONFIGURATION_load (cfg, cfg_filename));
  links = log (num_peers) * log (num_peers) * num_peers / 2;
  GNUNET_CONFIGURATION_set_value_number ((struct GNUNET_CONFIGURATION_Handle *)
                                         cfg, "TESTBED", "OVERLAY_RANDOM_LINKS",
                                         (unsigned long long int) links);
  GNUNET_TESTBED_run (NULL, cfg, num_peers, 0, NULL, NULL, &test_master, NULL);
  GNUNET_CONFIGURATION_destroy (cfg);
}


/**
 * Main function.
 *
 * @return 0 on success
 */
int
main (int argc, char *const *argv)
{
  static struct GNUNET_GETOPT_CommandLineOption options[] = {
    {'p', "peers", "COUNT", gettext_noop ("Number of peers to run"), GNUNET_YES,
     &GNUNET_GETOPT_set_uint, &num_peers},
    {'i', "sensors-interval", "INTERVAL",
     gettext_noop ("Change the interval or running sensors to given value"),
     GNUNET_YES, &GNUNET_GETOPT_set_uint, &sensors_interval},
    GNUNET_GETOPT_OPTION_END
  };

  return (GNUNET_OK ==
          GNUNET_PROGRAM_run (argc, argv, "gnunet-sensor-profiler",
                              gettext_noop ("Profiler for sensor service"),
                              options, &run, NULL)) ? ok : 1;
}

/* end of gnunet-sensor-profiler.c */