gnunet-nse-profiler.c

Go to the documentation of this file.

/*
     This file is part of GNUnet.
     Copyright (C) 2011, 2012 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
 */
#include "platform.h"
#include "gnunet_testbed_service.h"
#include "gnunet_nse_service.h"

#define LOG(kind, ...) GNUNET_log(kind, __VA_ARGS__)

#define LOG_DEBUG(...) LOG(GNUNET_ERROR_TYPE_DEBUG, __VA_ARGS__)


struct NSEPeer {
  struct NSEPeer *prev;

  struct NSEPeer *next;

  struct GNUNET_TESTBED_Peer *daemon;

  struct GNUNET_TESTBED_Operation *nse_op;

  struct GNUNET_TESTBED_Operation *stat_op;

  struct GNUNET_STATISTICS_Handle *sh;
};


struct OpListEntry {
  struct OpListEntry *next;

  struct OpListEntry *prev;

  struct GNUNET_TESTBED_Operation *op;

  int delta;
};


static struct NSEPeer *peer_head;

static struct NSEPeer *peer_tail;

static int ok;

static unsigned int verbose;

static char *hosts_file;

static unsigned int num_peers;

static unsigned int num_rounds;

static unsigned int current_round;

static unsigned int *num_peers_in_round;

static unsigned int peers_running;

static char *num_peer_spec;

static struct GNUNET_TESTBED_Peer **daemons;

static struct GNUNET_CONFIGURATION_Handle *testing_cfg;

static unsigned int connection_limit;

static unsigned int total_connections;

static struct GNUNET_DISK_FileHandle *output_file;

static char *output_filename;

static struct GNUNET_DISK_FileHandle *data_file;

static char *data_filename;

static struct GNUNET_TIME_Relative wait_time = { 60 * 1000 };

static struct OpListEntry *oplist_head;

static struct OpListEntry *oplist_tail;

static struct GNUNET_SCHEDULER_Task *round_task;


static void
close_monitor_connections()
{
  struct NSEPeer *pos;
  struct OpListEntry *oplist_entry;

  while (NULL != (pos = peer_head))
    {
      if (NULL != pos->nse_op)
        GNUNET_TESTBED_operation_done(pos->nse_op);
      if (NULL != pos->stat_op)
        GNUNET_TESTBED_operation_done(pos->stat_op);
      GNUNET_CONTAINER_DLL_remove(peer_head, peer_tail, pos);
      GNUNET_free(pos);
    }
  while (NULL != (oplist_entry = oplist_head))
    {
      GNUNET_CONTAINER_DLL_remove(oplist_head, oplist_tail, oplist_entry);
      GNUNET_TESTBED_operation_done(oplist_entry->op);
      GNUNET_free(oplist_entry);
    }
}


static void
shutdown_task(void *cls)
{
  LOG_DEBUG("Ending test.\n");
  close_monitor_connections();
  if (NULL != round_task)
    {
      GNUNET_SCHEDULER_cancel(round_task);
      round_task = NULL;
    }
  if (NULL != data_file)
    {
      GNUNET_DISK_file_close(data_file);
      data_file = NULL;
    }
  if (NULL != output_file)
    {
      GNUNET_DISK_file_close(output_file);
      output_file = NULL;
    }
  if (NULL != testing_cfg)
    {
      GNUNET_CONFIGURATION_destroy(testing_cfg);
      testing_cfg = NULL;
    }
}


static void
handle_estimate(void *cls,
                struct GNUNET_TIME_Absolute timestamp,
                double estimate,
                double std_dev)
{
  struct NSEPeer *peer = cls;
  char output_buffer[512];
  size_t size;

  if (NULL == output_file)
    {
      fprintf(stderr,
              "Received network size estimate from peer %p. Size: %f std.dev. %f\n",
              peer,
              estimate,
              std_dev);
      return;
    }
  size = GNUNET_snprintf(output_buffer,
                         sizeof(output_buffer),
                         "%p %llu %llu %f %f %f\n",
                         peer,
                         peers_running,
                         (unsigned long long)timestamp.abs_value_us,
                         GNUNET_NSE_log_estimate_to_n(estimate),
                         estimate,
                         std_dev);
  if (size != GNUNET_DISK_file_write(output_file, output_buffer, size))
    GNUNET_log(GNUNET_ERROR_TYPE_WARNING, "Unable to write to file!\n");
}


static void *
nse_connect_adapter(void *cls, const struct GNUNET_CONFIGURATION_Handle *cfg)
{
  struct NSEPeer *current_peer = cls;

  return GNUNET_NSE_connect(cfg, &handle_estimate, current_peer);
}


static void
nse_disconnect_adapter(void *cls, void *op_result)
{
  GNUNET_NSE_disconnect(op_result);
}


static int
stat_iterator(void *cls,
              const char *subsystem,
              const char *name,
              uint64_t value,
              int is_persistent)
{
  char *output_buffer;
  struct GNUNET_TIME_Absolute now;
  int size;
  unsigned int flag;

  GNUNET_assert(NULL != data_file);
  now = GNUNET_TIME_absolute_get();
  flag = strcasecmp(subsystem, "core");
  if (0 != flag)
    flag = 1;
  size = GNUNET_asprintf(&output_buffer,
                         "%llu %llu %u\n",
                         now.abs_value_us / 1000LL / 1000LL,
                         value,
                         flag);
  if (0 > size)
    {
      GNUNET_log(GNUNET_ERROR_TYPE_WARNING, "Error formatting output buffer.\n");
      GNUNET_free(output_buffer);
      return GNUNET_SYSERR;
    }
  if (size != GNUNET_DISK_file_write(data_file, output_buffer, (size_t)size))
    {
      GNUNET_log(GNUNET_ERROR_TYPE_WARNING, "Unable to write to file!\n");
      GNUNET_free(output_buffer);
      return GNUNET_SYSERR;
    }
  GNUNET_free(output_buffer);
  return GNUNET_OK;
}


static void *
stat_connect_adapter(void *cls, const struct GNUNET_CONFIGURATION_Handle *cfg)
{
  struct NSEPeer *peer = cls;

  peer->sh = GNUNET_STATISTICS_create("nse-profiler", cfg);
  return peer->sh;
}


static void
stat_disconnect_adapter(void *cls, void *op_result)
{
  struct NSEPeer *peer = cls;

  GNUNET_break(GNUNET_OK ==
               GNUNET_STATISTICS_watch_cancel(peer->sh,
                                              "core",
                                              "# peers connected",
                                              stat_iterator,
                                              peer));
  GNUNET_break(GNUNET_OK ==
               GNUNET_STATISTICS_watch_cancel(peer->sh,
                                              "nse",
                                              "# peers connected",
                                              stat_iterator,
                                              peer));
  GNUNET_STATISTICS_destroy(op_result, GNUNET_NO);
  peer->sh = NULL;
}


static void
stat_comp_cb(void *cls,
             struct GNUNET_TESTBED_Operation *op,
             void *ca_result,
             const char *emsg)
{
  struct GNUNET_STATISTICS_Handle *sh = ca_result;
  struct NSEPeer *peer = cls;

  if (NULL != emsg)
    {
      GNUNET_break(0);
      return;
    }
  GNUNET_break(GNUNET_OK == GNUNET_STATISTICS_watch(sh,
                                                    "core",
                                                    "# peers connected",
                                                    stat_iterator,
                                                    peer));
  GNUNET_break(GNUNET_OK == GNUNET_STATISTICS_watch(sh,
                                                    "nse",
                                                    "# peers connected",
                                                    stat_iterator,
                                                    peer));
}


static void
connect_nse_service()
{
  struct NSEPeer *current_peer;
  unsigned int i;
  unsigned int connections;

  if (0 == connection_limit)
    return;
  LOG_DEBUG("Connecting to nse service of peers\n");
  connections = 0;
  for (i = 0; i < num_peers_in_round[current_round]; i++)
    {
      if ((num_peers_in_round[current_round] > connection_limit) &&
          (0 != (i % (num_peers_in_round[current_round] / connection_limit))))
        continue;
      LOG_DEBUG("Connecting to nse service of peer %d\n", i);
      current_peer = GNUNET_new(struct NSEPeer);
      current_peer->daemon = daemons[i];
      current_peer->nse_op =
        GNUNET_TESTBED_service_connect(NULL,
                                       current_peer->daemon,
                                       "nse",
                                       NULL,
                                       NULL,
                                       &nse_connect_adapter,
                                       &nse_disconnect_adapter,
                                       current_peer);
      if (NULL != data_file)
        current_peer->stat_op =
          GNUNET_TESTBED_service_connect(NULL,
                                         current_peer->daemon,
                                         "statistics",
                                         stat_comp_cb,
                                         current_peer,
                                         &stat_connect_adapter,
                                         &stat_disconnect_adapter,
                                         current_peer);
      GNUNET_CONTAINER_DLL_insert(peer_head, peer_tail, current_peer);
      if (++connections == connection_limit)
        break;
    }
}


static void
next_round(void *cls);


static void
finish_round(void *cls)
{
  LOG(GNUNET_ERROR_TYPE_INFO, "Have %u connections\n", total_connections);
  close_monitor_connections();
  round_task = GNUNET_SCHEDULER_add_now(&next_round, NULL);
}


static void
run_round()
{
  LOG_DEBUG("Running round %u\n", current_round);
  connect_nse_service();
  GNUNET_SCHEDULER_add_delayed(wait_time, &finish_round, NULL);
}


static struct OpListEntry *
make_oplist_entry()
{
  struct OpListEntry *entry;

  entry = GNUNET_new(struct OpListEntry);
  GNUNET_CONTAINER_DLL_insert_tail(oplist_head, oplist_tail, entry);
  return entry;
}


static void
manage_service_cb(void *cls,
                  struct GNUNET_TESTBED_Operation *op,
                  const char *emsg)
{
  struct OpListEntry *entry = cls;

  GNUNET_TESTBED_operation_done(entry->op);
  if (NULL != emsg)
    {
      LOG(GNUNET_ERROR_TYPE_ERROR, "Failed to start/stop NSE at a peer\n");
      GNUNET_SCHEDULER_shutdown();
      return;
    }
  GNUNET_assert(0 != entry->delta);
  peers_running += entry->delta;
  GNUNET_CONTAINER_DLL_remove(oplist_head, oplist_tail, entry);
  GNUNET_free(entry);
  if (num_peers_in_round[current_round] == peers_running)
    run_round();
}


static void
adjust_running_peers()
{
  struct OpListEntry *entry;
  unsigned int i;

  /* start peers if we have too few */
  for (i = peers_running; i < num_peers_in_round[current_round]; i++)
    {
      entry = make_oplist_entry();
      entry->delta = 1;
      entry->op = GNUNET_TESTBED_peer_manage_service(NULL,
                                                     daemons[i],
                                                     "nse",
                                                     &manage_service_cb,
                                                     entry,
                                                     1);
    }
  /* stop peers if we have too many */
  for (i = num_peers_in_round[current_round]; i < peers_running; i++)
    {
      entry = make_oplist_entry();
      entry->delta = -1;
      entry->op = GNUNET_TESTBED_peer_manage_service(NULL,
                                                     daemons[i],
                                                     "nse",
                                                     &manage_service_cb,
                                                     entry,
                                                     0);
    }
}


static void
next_round(void *cls)
{
  round_task = NULL;
  LOG_DEBUG("Disconnecting nse service of peers\n");
  current_round++;
  if (current_round == num_rounds)
    {
      /* this was the last round, terminate */
      ok = 0;
      GNUNET_SCHEDULER_shutdown();
      return;
    }
  if (num_peers_in_round[current_round] == peers_running)
    {
      /* no need to churn, just run next round */
      run_round();
      return;
    }
  adjust_running_peers();
}


static void
master_controller_cb(void *cls,
                     const struct GNUNET_TESTBED_EventInformation *event)
{
  switch (event->type)
    {
    case GNUNET_TESTBED_ET_CONNECT:
      total_connections++;
      break;

    case GNUNET_TESTBED_ET_DISCONNECT:
      total_connections--;
      break;

    default:
      break;
    }
}


static void
test_master(void *cls,
            struct GNUNET_TESTBED_RunHandle *h,
            unsigned int num_peers_,
            struct GNUNET_TESTBED_Peer **peers,
            unsigned int links_succeeded,
            unsigned int links_failed)
{
  if (NULL == peers)
    {
      GNUNET_SCHEDULER_shutdown();
      return;
    }
  daemons = peers;
  GNUNET_break(num_peers_ == num_peers);
  peers_running = num_peers;
  if (num_peers_in_round[current_round] == peers_running)
    {
      /* no need to churn, just run the starting round */
      run_round();
      return;
    }
  adjust_running_peers();
}


static void
run(void *cls,
    char *const *args,
    const char *cfgfile,
    const struct GNUNET_CONFIGURATION_Handle *cfg)
{
  char *tok;
  uint64_t event_mask;
  unsigned int num;

  ok = 1;
  testing_cfg = GNUNET_CONFIGURATION_dup(cfg);
  LOG_DEBUG("Starting daemons.\n");
  if (NULL == num_peer_spec)
    {
      fprintf(stderr, "You need to specify the number of peers to run\n");
      return;
    }
  for (tok = strtok(num_peer_spec, ","); NULL != tok; tok = strtok(NULL, ","))
    {
      if (1 != sscanf(tok, "%u", &num))
        {
          fprintf(stderr, "You need to specify numbers, not `%s'\n", tok);
          return;
        }
      if (0 == num)
        {
          fprintf(stderr, "Refusing to run a round with 0 peers\n");
          return;
        }
      GNUNET_array_append(num_peers_in_round, num_rounds, num);
      num_peers = GNUNET_MAX(num_peers, num);
    }
  if (0 == num_peers)
    {
      fprintf(stderr, "Refusing to run a testbed with no rounds\n");
      return;
    }
  if ((NULL != data_filename) &&
      (NULL ==
       (data_file = GNUNET_DISK_file_open(data_filename,
                                          GNUNET_DISK_OPEN_READWRITE |
                                          GNUNET_DISK_OPEN_TRUNCATE |
                                          GNUNET_DISK_OPEN_CREATE,
                                          GNUNET_DISK_PERM_USER_READ |
                                          GNUNET_DISK_PERM_USER_WRITE))))
    GNUNET_log_strerror_file(GNUNET_ERROR_TYPE_ERROR, "open", data_filename);

  if ((NULL != output_filename) &&
      (NULL ==
       (output_file = GNUNET_DISK_file_open(output_filename,
                                            GNUNET_DISK_OPEN_READWRITE |
                                            GNUNET_DISK_OPEN_CREATE,
                                            GNUNET_DISK_PERM_USER_READ |
                                            GNUNET_DISK_PERM_USER_WRITE))))
    GNUNET_log_strerror_file(GNUNET_ERROR_TYPE_ERROR, "open", output_filename);
  event_mask = 0LL;
  event_mask |= (1LL << GNUNET_TESTBED_ET_PEER_START);
  event_mask |= (1LL << GNUNET_TESTBED_ET_PEER_STOP);
  event_mask |= (1LL << GNUNET_TESTBED_ET_CONNECT);
  event_mask |= (1LL << GNUNET_TESTBED_ET_DISCONNECT);
  GNUNET_TESTBED_run(hosts_file,
                     cfg,
                     num_peers,
                     event_mask,
                     master_controller_cb,
                     NULL,  /* master_controller_cb cls */
                     &test_master,
                     NULL);  /* test_master cls */
  GNUNET_SCHEDULER_add_shutdown(&shutdown_task, NULL);
}


int
main(int argc, char *const *argv)
{
  struct GNUNET_GETOPT_CommandLineOption options[] =
  { GNUNET_GETOPT_option_uint(
      'C',
      "connections",
      "COUNT",
      gettext_noop(
        "limit to the number of connections to NSE services, 0 for none"),
      &connection_limit),
    GNUNET_GETOPT_option_string(
      'd',
      "details",
      "FILENAME",
      gettext_noop(
        "name of the file for writing connection information and statistics"),
      &data_filename),

    GNUNET_GETOPT_option_string(
      'H',
      "hosts",
      "FILENAME",
      gettext_noop(
        "name of the file with the login information for the testbed"),
      &hosts_file),

    GNUNET_GETOPT_option_string(
      'o',
      "output",
      "FILENAME",
      gettext_noop("name of the file for writing the main results"),
      &output_filename),


    GNUNET_GETOPT_option_string(
      'p',
      "peers",
      "NETWORKSIZESPEC",
      gettext_noop(
        "Number of peers to run in each round, separated by commas"),
      &num_peer_spec),

    GNUNET_GETOPT_option_increment_uint(
      'V',
      "verbose",
      gettext_noop("be verbose (print progress information)"),
      &verbose),

    GNUNET_GETOPT_option_relative_time('w',
                                       "wait",
                                       "DELAY",
                                       gettext_noop("delay between rounds"),
                                       &wait_time),
    GNUNET_GETOPT_OPTION_END };

  if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args(argc, argv, &argc, &argv))
    return 2;
  if (
    GNUNET_OK !=
    GNUNET_PROGRAM_run(argc,
                       argv,
                       "nse-profiler",
                       gettext_noop(
                         "Measure quality and performance of the NSE service."),
                       options,
                       &run,
                       NULL))
    ok = 1;
  return ok;
}

/* end of nse-profiler.c */