2 This file is part of GNUnet
3 Copyright (C) 2008--2013 GNUnet e.V.
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
22 * @file testbed/testbed_api_statistics.c
23 * @brief high-level statistics function
24 * @author Christian Grothoff
25 * @author Sree Harsha Totakura
28 #include "gnunet_util_lib.h"
29 #include "gnunet_testbed_service.h"
31 #include "testbed_api_operations.h"
35 * Generic logging shorthand
37 #define LOG(kind,...) \
38 GNUNET_log_from (kind, "testbed-api-statistics", __VA_ARGS__)
41 * Debug logging shorthand
43 #define LOG_DEBUG(...) \
44 LOG (GNUNET_ERROR_TYPE_DEBUG, __VA_ARGS__)
48 * Context information for use in GNUNET_TESTBED_get_statistics()
50 struct GetStatsContext
53 * The main operation we generate while creating this context
55 struct GNUNET_TESTBED_Operation *main_op;
58 * The service connect operations we create to open connection to the
59 * statistics service of each given peer
61 struct GNUNET_TESTBED_Operation **ops;
64 * The array of peers whose statistics services are to be accessed
66 struct GNUNET_TESTBED_Peer **peers;
69 * The subsystem of peers for which statistics are requested
74 * The particular statistics value of interest
79 * The iterator to call with statistics information
81 GNUNET_TESTBED_StatisticsIterator proc;
84 * The callback to call when we are done iterating through all peers'
87 GNUNET_TESTBED_OperationCompletionCallback cont;
90 * The closure for the above callbacks
95 * The task for calling the continuation callback
97 struct GNUNET_SCHEDULER_Task * call_completion_task_id;
100 * The number of peers present in the peers array. This number also
101 * represents the number of service connect operations in the ops array
103 unsigned int num_peers;
106 * How many peers' statistics have we iterated through
108 unsigned int num_completed;
114 * Context information with respect to a particular peer
116 struct PeerGetStatsContext
119 * The GetStatsContext which is associated with this context
121 struct GetStatsContext *sc;
124 * The handle from GNUNET_STATISTICS_get()
126 struct GNUNET_STATISTICS_GetHandle *get_handle;
129 * Task to mark the statistics service connect operation as done
131 struct GNUNET_SCHEDULER_Task * op_done_task_id;
134 * The index of this peer in the peers array of GetStatsContext
136 unsigned int peer_index;
141 * A no-wait operation queue
143 static struct OperationQueue *no_wait_queue;
147 * Call statistics operation completion. We call it in a separate task because
148 * the iteration_completion_cb() cannot destroy statistics handle which will be
149 * the case if the user calles GNUNET_TESTBED_operation_done() on the
150 * get_statistics operation.
152 * @param cls the GetStatsContext
155 call_completion_task (void *cls)
157 struct GetStatsContext *sc = cls;
159 GNUNET_assert (sc->call_completion_task_id != NULL);
160 sc->call_completion_task_id = NULL;
161 LOG_DEBUG ("Calling get_statistics() continuation callback\n");
162 sc->cont (sc->cb_cls, sc->main_op, NULL);
167 * Task to mark statistics service connect operation as done. We call it here
168 * as we cannot destroy the statistics handle in iteration_completion_cb()
170 * @param cls the PeerGetStatsContext
173 op_done_task (void *cls)
175 struct PeerGetStatsContext *peer_sc = cls;
176 struct GetStatsContext *sc;
177 struct GNUNET_TESTBED_Operation **op;
180 peer_sc->op_done_task_id = NULL;
181 op = &sc->ops[peer_sc->peer_index];
182 GNUNET_assert (NULL != *op);
183 GNUNET_TESTBED_operation_done (*op);
189 * Continuation called by the "get_all" and "get" functions.
191 * @param cls the PeerGetStatsContext
192 * @param success GNUNET_OK if statistics were
193 * successfully obtained, GNUNET_SYSERR if not.
196 iteration_completion_cb (void *cls, int success)
198 struct PeerGetStatsContext *peer_sc = cls;
199 struct GetStatsContext *sc;
201 GNUNET_break (GNUNET_OK == success);
203 peer_sc->get_handle = NULL;
205 peer_sc->op_done_task_id = GNUNET_SCHEDULER_add_now (&op_done_task, peer_sc);
206 if (sc->num_completed == sc->num_peers)
208 LOG_DEBUG ("Scheduling to call iteration completion callback\n");
209 sc->call_completion_task_id =
210 GNUNET_SCHEDULER_add_now (&call_completion_task, sc);
216 * Callback function to process statistic values.
218 * @param cls the PeerGetStatsContext
219 * @param subsystem name of subsystem that created the statistic
220 * @param name the name of the datum
221 * @param value the current value
222 * @param is_persistent GNUNET_YES if the value is persistent, GNUNET_NO if not
223 * @return GNUNET_OK to continue, GNUNET_SYSERR to abort iteration
226 iterator_cb (void *cls, const char *subsystem,
227 const char *name, uint64_t value,
230 struct PeerGetStatsContext *peer_sc = cls;
231 struct GetStatsContext *sc;
232 struct GNUNET_TESTBED_Peer *peer;
236 peer = sc->peers[peer_sc->peer_index];
237 LOG_DEBUG ("Peer %u: [%s,%s] -> %lu\n", peer_sc->peer_index,
238 subsystem, name, (unsigned long) value);
239 ret = sc->proc (sc->cb_cls, peer,
240 subsystem, name, value, is_persistent);
241 if (GNUNET_SYSERR == ret)
242 LOG_DEBUG ("Aborting iteration for peer %u\n", peer_sc->peer_index);
248 * Called after opening a connection to the statistics service of a peer
250 * @param cls the PeerGetStatsContext
251 * @param op the operation that has been finished
252 * @param ca_result the service handle returned from GNUNET_TESTBED_ConnectAdapter()
253 * @param emsg error message in case the operation has failed; will be NULL if
254 * operation has executed successfully.
257 service_connect_comp (void *cls,
258 struct GNUNET_TESTBED_Operation *op,
262 struct PeerGetStatsContext *peer_sc = cls;
263 struct GNUNET_STATISTICS_Handle *h = ca_result;
265 LOG_DEBUG ("Retrieving statistics of peer %u\n",
266 peer_sc->peer_index);
267 peer_sc->get_handle =
268 GNUNET_STATISTICS_get (h, peer_sc->sc->subsystem,
270 &iteration_completion_cb,
271 iterator_cb, peer_sc);
276 * Adapter function called to establish a connection to the statistics service
279 * @param cls the PeerGetStatsContext
280 * @param cfg configuration of the peer to connect to; will be available until
281 * GNUNET_TESTBED_operation_done() is called on the operation returned
282 * from GNUNET_TESTBED_service_connect()
283 * @return service handle to return in 'op_result', NULL on error
286 statistics_ca (void *cls, const struct GNUNET_CONFIGURATION_Handle *cfg)
288 struct PeerGetStatsContext *peer_sc = cls;
290 LOG_DEBUG ("Connecting to statistics service of peer %u\n",
291 peer_sc->peer_index);
292 return GNUNET_STATISTICS_create ("<testbed-api>", cfg);
297 * Adapter function called to destroy statistics connection
299 * @param cls the PeerGetStatsContext
300 * @param op_result service handle returned from the connect adapter
303 statistics_da (void *cls, void *op_result)
305 struct PeerGetStatsContext *peer_sc = cls;
306 struct GNUNET_STATISTICS_Handle *sh = op_result;
308 if (NULL != peer_sc->get_handle)
310 GNUNET_STATISTICS_get_cancel (peer_sc->get_handle);
311 peer_sc->get_handle = NULL;
313 GNUNET_STATISTICS_destroy (sh, GNUNET_NO);
314 if (NULL != peer_sc->op_done_task_id)
315 GNUNET_SCHEDULER_cancel (peer_sc->op_done_task_id);
316 GNUNET_free (peer_sc);
321 * Function called when get_statistics operation is ready
323 * @param cls the GetStatsContext
326 opstart_get_stats (void *cls)
328 struct GetStatsContext *sc = cls;
329 struct PeerGetStatsContext *peer_sc;
332 LOG_DEBUG ("Starting get_statistics operation\n");
333 sc->ops = GNUNET_malloc (sc->num_peers *
334 sizeof (struct GNUNET_TESTBED_Operation *));
335 for (peer = 0; peer < sc->num_peers; peer++)
337 if (NULL == sc->peers[peer])
342 peer_sc = GNUNET_new (struct PeerGetStatsContext);
344 peer_sc->peer_index = peer;
346 GNUNET_TESTBED_service_connect (sc, sc->peers[peer], "statistics",
347 &service_connect_comp,
357 * Function called when get_statistics operation is cancelled or marked as done
359 * @param cls the GetStatsContext
362 oprelease_get_stats (void *cls)
364 struct GetStatsContext *sc = cls;
367 LOG_DEBUG ("Cleaning up get_statistics operation\n");
368 if (NULL != sc->call_completion_task_id)
369 GNUNET_SCHEDULER_cancel (sc->call_completion_task_id);
372 for (peer = 0; peer < sc->num_peers; peer++)
374 if (NULL != sc->ops[peer])
376 GNUNET_TESTBED_operation_done (sc->ops[peer]);
377 sc->ops[peer] = NULL;
380 GNUNET_free (sc->ops);
382 GNUNET_free_non_null (sc->subsystem);
383 GNUNET_free_non_null (sc->name);
386 GNUNET_TESTBED_operation_queue_destroy_empty_ (no_wait_queue))
387 no_wait_queue = NULL;
392 * Convenience method that iterates over all (running) peers
393 * and retrieves all statistics from each peer.
395 * @param num_peers number of peers to iterate over
396 * @param peers array of peers to iterate over
397 * @param subsystem limit to the specified subsystem, NULL for all subsystems
398 * @param name name of the statistic value, NULL for all values
399 * @param proc processing function for each statistic retrieved
400 * @param cont continuation to call once call is completed(?)
401 * @param cls closure to pass to proc and cont
402 * @return operation handle to cancel the operation
404 struct GNUNET_TESTBED_Operation *
405 GNUNET_TESTBED_get_statistics (unsigned int num_peers,
406 struct GNUNET_TESTBED_Peer **peers,
407 const char *subsystem, const char *name,
408 GNUNET_TESTBED_StatisticsIterator proc,
409 GNUNET_TESTBED_OperationCompletionCallback cont,
412 struct GetStatsContext *sc;
414 GNUNET_assert (NULL != proc);
415 GNUNET_assert (NULL != cont);
416 if (NULL == no_wait_queue)
417 no_wait_queue = GNUNET_TESTBED_operation_queue_create_
418 (OPERATION_QUEUE_TYPE_FIXED, UINT_MAX);
419 sc = GNUNET_new (struct GetStatsContext);
421 sc->subsystem = (NULL == subsystem) ? NULL : GNUNET_strdup (subsystem);
422 sc->name = (NULL == name) ? NULL : GNUNET_strdup (name);
426 sc->num_peers = num_peers;
428 GNUNET_TESTBED_operation_create_ (sc, &opstart_get_stats,
429 &oprelease_get_stats);
430 GNUNET_TESTBED_operation_queue_insert_ (no_wait_queue, sc->main_op);
431 GNUNET_TESTBED_operation_begin_wait_ (sc->main_op);
436 /* end of testbed_api_statistics.c */