testbed_api_statistics.c File Reference

high-level statistics function More...

#include "platform.h"
#include "gnunet_util_lib.h"
#include "gnunet_testbed_service.h"
#include "testbed_api_operations.h"

Include dependency graph for testbed_api_statistics.c:

Go to the source code of this file.

Data Structures
struct	GetStatsContext
	Context information for use in GNUNET_TESTBED_get_statistics() More...
struct	PeerGetStatsContext
	Context information with respect to a particular peer. More...

Macros
#define	LOG(kind, ...)    GNUNET_log_from (kind, "testbed-api-statistics", __VA_ARGS__)
	Generic logging shorthand. More...
#define	LOG_DEBUG(...)    LOG (GNUNET_ERROR_TYPE_DEBUG, __VA_ARGS__)
	Debug logging shorthand. More...

Functions
static void	call_completion_task (void *cls)
	Call statistics operation completion. More...
static void	op_done_task (void *cls)
	Task to mark statistics service connect operation as done. More...
static void	iteration_completion_cb (void *cls, int success)
	Continuation called by the "get_all" and "get" functions. More...
static int	iterator_cb (void *cls, const char *subsystem, const char *name, uint64_t value, int is_persistent)
	Callback function to process statistic values. More...
static void	service_connect_comp (void *cls, struct GNUNET_TESTBED_Operation *op, void *ca_result, const char *emsg)
	Called after opening a connection to the statistics service of a peer. More...
static void *	statistics_ca (void *cls, const struct GNUNET_CONFIGURATION_Handle *cfg)
	Adapter function called to establish a connection to the statistics service of a peer. More...
static void	statistics_da (void *cls, void *op_result)
	Adapter function called to destroy statistics connection. More...
static void	opstart_get_stats (void *cls)
	Function called when get_statistics operation is ready. More...
static void	oprelease_get_stats (void *cls)
	Function called when get_statistics operation is cancelled or marked as done. More...
struct GNUNET_TESTBED_Operation *	GNUNET_TESTBED_get_statistics (unsigned int num_peers, struct GNUNET_TESTBED_Peer **peers, const char *subsystem, const char *name, GNUNET_TESTBED_StatisticsIterator proc, GNUNET_TESTBED_OperationCompletionCallback cont, void *cls)
	Convenience method that iterates over all (running) peers and retrieves all statistics from each peer. More...

Variables
static struct OperationQueue *	no_wait_queue
	A no-wait operation queue. More...

Detailed Description

high-level statistics function

Author

Christian Grothoff

Sree Harsha Totakura

Definition in file testbed_api_statistics.c.

Macro Definition Documentation

LOG

#define LOG	(		kind,
			...
	)		GNUNET_log_from (kind, "testbed-api-statistics", __VA_ARGS__)

Generic logging shorthand.

Definition at line 37 of file testbed_api_statistics.c.

LOG_DEBUG

#define LOG_DEBUG

(

...

)

LOG (GNUNET_ERROR_TYPE_DEBUG, __VA_ARGS__)

Debug logging shorthand.

Definition at line 43 of file testbed_api_statistics.c.

Function Documentation

call_completion_task()

static void call_completion_task ( void *  cls )

static

Call statistics operation completion.

We call it in a separate task because the iteration_completion_cb() cannot destroy statistics handle which will be the case if the user calls GNUNET_TESTBED_operation_done() on the get_statistics operation.

Parameters

cls	the GetStatsContext

Definition at line 154 of file testbed_api_statistics.c.

{
  struct GetStatsContext *sc = cls;
 
  GNUNET_assert (sc->call_completion_task_id != NULL);
  sc->call_completion_task_id = NULL;
  LOG_DEBUG ("Calling get_statistics() continuation callback\n");
  sc->cont (sc->cb_cls, sc->main_op, NULL);
}

References GNUNET_assert, LOG_DEBUG, and sc.

Referenced by iteration_completion_cb().

Here is the caller graph for this function:

op_done_task()

static void op_done_task ( void *  cls )

static

Task to mark statistics service connect operation as done.

We call it here as we cannot destroy the statistics handle in iteration_completion_cb()

Parameters

cls	the PeerGetStatsContext

Definition at line 172 of file testbed_api_statistics.c.

{
  struct PeerGetStatsContext *peer_sc = cls;
  struct GetStatsContext *sc;
  struct GNUNET_TESTBED_Operation **op;
 
  sc = peer_sc->sc;
  peer_sc->op_done_task_id = NULL;
  op = &sc->ops[peer_sc->peer_index];
  GNUNET_assert (NULL != *op);
  GNUNET_TESTBED_operation_done (*op);
  *op = NULL;
}

References GNUNET_assert, GNUNET_TESTBED_operation_done(), op, PeerGetStatsContext::op_done_task_id, PeerGetStatsContext::peer_index, sc, and PeerGetStatsContext::sc.

Referenced by iteration_completion_cb().

Here is the call graph for this function:

Here is the caller graph for this function:

iteration_completion_cb()

static void iteration_completion_cb ( void *  cls, int  success  )

static

Continuation called by the "get_all" and "get" functions.

Parameters

cls	the PeerGetStatsContext
success	GNUNET_OK if statistics were successfully obtained, GNUNET_SYSERR if not.

Definition at line 195 of file testbed_api_statistics.c.

{
  struct PeerGetStatsContext *peer_sc = cls;
  struct GetStatsContext *sc;
 
  GNUNET_break (GNUNET_OK == success);
  sc = peer_sc->sc;
  peer_sc->get_handle = NULL;
  sc->num_completed++;
  peer_sc->op_done_task_id = GNUNET_SCHEDULER_add_now (&op_done_task, peer_sc);
  if (sc->num_completed == sc->num_peers)
  {
    LOG_DEBUG ("Scheduling to call iteration completion callback\n");
    sc->call_completion_task_id =
      GNUNET_SCHEDULER_add_now (&call_completion_task, sc);
  }
}

References call_completion_task(), PeerGetStatsContext::get_handle, GNUNET_break, GNUNET_OK, GNUNET_SCHEDULER_add_now(), LOG_DEBUG, op_done_task(), PeerGetStatsContext::op_done_task_id, sc, and PeerGetStatsContext::sc.

Referenced by service_connect_comp().

Here is the call graph for this function:

Here is the caller graph for this function:

iterator_cb()

static int iterator_cb ( void *  cls, const char *  subsystem, const char *  name, uint64_t  value, int  is_persistent  )

static

Callback function to process statistic values.

Parameters

cls	the PeerGetStatsContext
subsystem	name of subsystem that created the statistic
name	the name of the datum
value	the current value
is_persistent	GNUNET_YES if the value is persistent, GNUNET_NO if not

Returns

GNUNET_OK to continue, GNUNET_SYSERR to abort iteration

Definition at line 225 of file testbed_api_statistics.c.

{
  struct PeerGetStatsContext *peer_sc = cls;
  struct GetStatsContext *sc;
  struct GNUNET_TESTBED_Peer *peer;
  int ret;
 
  sc = peer_sc->sc;
  peer = sc->peers[peer_sc->peer_index];
  LOG_DEBUG ("Peer %u: [%s,%s] -> %lu\n", peer_sc->peer_index,
             subsystem, name, (unsigned long) value);
  ret = sc->proc (sc->cb_cls, peer,
                  subsystem, name, value, is_persistent);
  if (GNUNET_SYSERR == ret)
    LOG_DEBUG ("Aborting iteration for peer %u\n", peer_sc->peer_index);
  return ret;
}

References GNUNET_SYSERR, LOG_DEBUG, name, peer, PeerGetStatsContext::peer_index, ret, sc, PeerGetStatsContext::sc, subsystem, and value.

Referenced by service_connect_comp().

Here is the caller graph for this function:

service_connect_comp()

static void service_connect_comp ( void *  cls, struct GNUNET_TESTBED_Operation *  op, void *  ca_result, const char *  emsg  )

static

Called after opening a connection to the statistics service of a peer.

Parameters

cls	the PeerGetStatsContext
op	the operation that has been finished
ca_result	the service handle returned from GNUNET_TESTBED_ConnectAdapter()
emsg	error message in case the operation has failed; will be NULL if operation has executed successfully.

Definition at line 256 of file testbed_api_statistics.c.

{
  struct PeerGetStatsContext *peer_sc = cls;
  struct GNUNET_STATISTICS_Handle *h = ca_result;
 
  LOG_DEBUG ("Retrieving statistics of peer %u\n",
             peer_sc->peer_index);
  peer_sc->get_handle =
    GNUNET_STATISTICS_get (h, peer_sc->sc->subsystem,
                           peer_sc->sc->name,
                           &iteration_completion_cb,
                           iterator_cb, peer_sc);
}

References PeerGetStatsContext::get_handle, GNUNET_STATISTICS_get(), h, iteration_completion_cb(), iterator_cb(), LOG_DEBUG, GetStatsContext::name, PeerGetStatsContext::peer_index, PeerGetStatsContext::sc, and GetStatsContext::subsystem.

Referenced by opstart_get_stats().

Here is the call graph for this function:

Here is the caller graph for this function:

statistics_ca()

static void* statistics_ca ( void *  cls, const struct GNUNET_CONFIGURATION_Handle *  cfg  )

static

Adapter function called to establish a connection to the statistics service of a peer.

Parameters

cls	the PeerGetStatsContext
cfg	configuration of the peer to connect to; will be available until GNUNET_TESTBED_operation_done() is called on the operation returned from GNUNET_TESTBED_service_connect()

Returns

service handle to return in 'op_result', NULL on error

Definition at line 285 of file testbed_api_statistics.c.

{
  struct PeerGetStatsContext *peer_sc = cls;
 
  LOG_DEBUG ("Connecting to statistics service of peer %u\n",
             peer_sc->peer_index);
  return GNUNET_STATISTICS_create ("<testbed-api>", cfg);
}

References cfg, GNUNET_STATISTICS_create(), LOG_DEBUG, and PeerGetStatsContext::peer_index.

Referenced by opstart_get_stats().

Here is the call graph for this function:

Here is the caller graph for this function:

statistics_da()

static void statistics_da ( void *  cls, void *  op_result  )

static

Adapter function called to destroy statistics connection.

Parameters

cls	the PeerGetStatsContext
op_result	service handle returned from the connect adapter

Definition at line 302 of file testbed_api_statistics.c.

{
  struct PeerGetStatsContext *peer_sc = cls;
  struct GNUNET_STATISTICS_Handle *sh = op_result;
 
  if (NULL != peer_sc->get_handle)
  {
    GNUNET_STATISTICS_get_cancel (peer_sc->get_handle);
    peer_sc->get_handle = NULL;
  }
  GNUNET_STATISTICS_destroy (sh, GNUNET_NO);
  if (NULL != peer_sc->op_done_task_id)
    GNUNET_SCHEDULER_cancel (peer_sc->op_done_task_id);
  GNUNET_free (peer_sc);
}

References PeerGetStatsContext::get_handle, GNUNET_free, GNUNET_NO, GNUNET_SCHEDULER_cancel(), GNUNET_STATISTICS_destroy(), GNUNET_STATISTICS_get_cancel(), PeerGetStatsContext::op_done_task_id, op_result(), and sh.

Referenced by opstart_get_stats().

Here is the call graph for this function:

Here is the caller graph for this function:

opstart_get_stats()

static void opstart_get_stats ( void *  cls )

static

Function called when get_statistics operation is ready.

Parameters

cls	the GetStatsContext

Definition at line 325 of file testbed_api_statistics.c.

{
  struct GetStatsContext *sc = cls;
  struct PeerGetStatsContext *peer_sc;
  unsigned int peer;
 
  LOG_DEBUG ("Starting get_statistics operation\n");
  sc->ops = GNUNET_malloc (sc->num_peers
                           * sizeof(struct GNUNET_TESTBED_Operation *));
  for (peer = 0; peer < sc->num_peers; peer++)
  {
    if (NULL == sc->peers[peer])
    {
      GNUNET_break (0);
      continue;
    }
    peer_sc = GNUNET_new (struct PeerGetStatsContext);
    peer_sc->sc = sc;
    peer_sc->peer_index = peer;
    sc->ops[peer] =
      GNUNET_TESTBED_service_connect (sc, sc->peers[peer], "statistics",
                                      &service_connect_comp,
                                      peer_sc,
                                      &statistics_ca,
                                      &statistics_da,
                                      peer_sc);
  }
}

References GNUNET_break, GNUNET_malloc, GNUNET_new, GNUNET_TESTBED_service_connect(), LOG_DEBUG, peer, PeerGetStatsContext::peer_index, sc, PeerGetStatsContext::sc, service_connect_comp(), statistics_ca(), and statistics_da().

Referenced by GNUNET_TESTBED_get_statistics().

Here is the call graph for this function:

Here is the caller graph for this function:

oprelease_get_stats()

static void oprelease_get_stats ( void *  cls )

static

Function called when get_statistics operation is cancelled or marked as done.

Parameters

cls	the GetStatsContext

Definition at line 361 of file testbed_api_statistics.c.

{
  struct GetStatsContext *sc = cls;
  unsigned int peer;
 
  LOG_DEBUG ("Cleaning up get_statistics operation\n");
  if (NULL != sc->call_completion_task_id)
    GNUNET_SCHEDULER_cancel (sc->call_completion_task_id);
  if (NULL != sc->ops)
  {
    for (peer = 0; peer < sc->num_peers; peer++)
    {
      if (NULL != sc->ops[peer])
      {
        GNUNET_TESTBED_operation_done (sc->ops[peer]);
        sc->ops[peer] = NULL;
      }
    }
    GNUNET_free (sc->ops);
  }
  GNUNET_free (sc->subsystem);
  GNUNET_free (sc->name);
  GNUNET_free (sc);
  if (GNUNET_YES ==
      GNUNET_TESTBED_operation_queue_destroy_empty_ (no_wait_queue))
    no_wait_queue = NULL;
}

References GNUNET_free, GNUNET_SCHEDULER_cancel(), GNUNET_TESTBED_operation_done(), GNUNET_TESTBED_operation_queue_destroy_empty_(), GNUNET_YES, LOG_DEBUG, no_wait_queue, peer, and sc.

Referenced by GNUNET_TESTBED_get_statistics().

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

no_wait_queue

struct OperationQueue* no_wait_queue

static

A no-wait operation queue.

Definition at line 142 of file testbed_api_statistics.c.

Referenced by GNUNET_TESTBED_get_statistics(), and oprelease_get_stats().