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 it
6 under the terms of the GNU Affero General Public License as published
7 by the Free Software Foundation, either version 3 of the License,
8 or (at your 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 Affero General Public License for more details.
15 You should have received a copy of the GNU Affero General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
20 * @file testbed/testbed_api_statistics.c
21 * @brief high-level statistics function
22 * @author Christian Grothoff
23 * @author Sree Harsha Totakura
26 #include "gnunet_util_lib.h"
27 #include "gnunet_testbed_service.h"
29 #include "testbed_api_operations.h"
33 * Generic logging shorthand
35 #define LOG(kind,...) \
36 GNUNET_log_from (kind, "testbed-api-statistics", __VA_ARGS__)
39 * Debug logging shorthand
41 #define LOG_DEBUG(...) \
42 LOG (GNUNET_ERROR_TYPE_DEBUG, __VA_ARGS__)
46 * Context information for use in GNUNET_TESTBED_get_statistics()
48 struct GetStatsContext
51 * The main operation we generate while creating this context
53 struct GNUNET_TESTBED_Operation *main_op;
56 * The service connect operations we create to open connection to the
57 * statistics service of each given peer
59 struct GNUNET_TESTBED_Operation **ops;
62 * The array of peers whose statistics services are to be accessed
64 struct GNUNET_TESTBED_Peer **peers;
67 * The subsystem of peers for which statistics are requested
72 * The particular statistics value of interest
77 * The iterator to call with statistics information
79 GNUNET_TESTBED_StatisticsIterator proc;
82 * The callback to call when we are done iterating through all peers'
85 GNUNET_TESTBED_OperationCompletionCallback cont;
88 * The closure for the above callbacks
93 * The task for calling the continuation callback
95 struct GNUNET_SCHEDULER_Task * call_completion_task_id;
98 * The number of peers present in the peers array. This number also
99 * represents the number of service connect operations in the ops array
101 unsigned int num_peers;
104 * How many peers' statistics have we iterated through
106 unsigned int num_completed;
112 * Context information with respect to a particular peer
114 struct PeerGetStatsContext
117 * The GetStatsContext which is associated with this context
119 struct GetStatsContext *sc;
122 * The handle from GNUNET_STATISTICS_get()
124 struct GNUNET_STATISTICS_GetHandle *get_handle;
127 * Task to mark the statistics service connect operation as done
129 struct GNUNET_SCHEDULER_Task * op_done_task_id;
132 * The index of this peer in the peers array of GetStatsContext
134 unsigned int peer_index;
139 * A no-wait operation queue
141 static struct OperationQueue *no_wait_queue;
145 * Call statistics operation completion. We call it in a separate task because
146 * the iteration_completion_cb() cannot destroy statistics handle which will be
147 * the case if the user calles GNUNET_TESTBED_operation_done() on the
148 * get_statistics operation.
150 * @param cls the GetStatsContext
153 call_completion_task (void *cls)
155 struct GetStatsContext *sc = cls;
157 GNUNET_assert (sc->call_completion_task_id != NULL);
158 sc->call_completion_task_id = NULL;
159 LOG_DEBUG ("Calling get_statistics() continuation callback\n");
160 sc->cont (sc->cb_cls, sc->main_op, NULL);
165 * Task to mark statistics service connect operation as done. We call it here
166 * as we cannot destroy the statistics handle in iteration_completion_cb()
168 * @param cls the PeerGetStatsContext
171 op_done_task (void *cls)
173 struct PeerGetStatsContext *peer_sc = cls;
174 struct GetStatsContext *sc;
175 struct GNUNET_TESTBED_Operation **op;
178 peer_sc->op_done_task_id = NULL;
179 op = &sc->ops[peer_sc->peer_index];
180 GNUNET_assert (NULL != *op);
181 GNUNET_TESTBED_operation_done (*op);
187 * Continuation called by the "get_all" and "get" functions.
189 * @param cls the PeerGetStatsContext
190 * @param success GNUNET_OK if statistics were
191 * successfully obtained, GNUNET_SYSERR if not.
194 iteration_completion_cb (void *cls, int success)
196 struct PeerGetStatsContext *peer_sc = cls;
197 struct GetStatsContext *sc;
199 GNUNET_break (GNUNET_OK == success);
201 peer_sc->get_handle = NULL;
203 peer_sc->op_done_task_id = GNUNET_SCHEDULER_add_now (&op_done_task, peer_sc);
204 if (sc->num_completed == sc->num_peers)
206 LOG_DEBUG ("Scheduling to call iteration completion callback\n");
207 sc->call_completion_task_id =
208 GNUNET_SCHEDULER_add_now (&call_completion_task, sc);
214 * Callback function to process statistic values.
216 * @param cls the PeerGetStatsContext
217 * @param subsystem name of subsystem that created the statistic
218 * @param name the name of the datum
219 * @param value the current value
220 * @param is_persistent GNUNET_YES if the value is persistent, GNUNET_NO if not
221 * @return GNUNET_OK to continue, GNUNET_SYSERR to abort iteration
224 iterator_cb (void *cls, const char *subsystem,
225 const char *name, uint64_t value,
228 struct PeerGetStatsContext *peer_sc = cls;
229 struct GetStatsContext *sc;
230 struct GNUNET_TESTBED_Peer *peer;
234 peer = sc->peers[peer_sc->peer_index];
235 LOG_DEBUG ("Peer %u: [%s,%s] -> %lu\n", peer_sc->peer_index,
236 subsystem, name, (unsigned long) value);
237 ret = sc->proc (sc->cb_cls, peer,
238 subsystem, name, value, is_persistent);
239 if (GNUNET_SYSERR == ret)
240 LOG_DEBUG ("Aborting iteration for peer %u\n", peer_sc->peer_index);
246 * Called after opening a connection to the statistics service of a peer
248 * @param cls the PeerGetStatsContext
249 * @param op the operation that has been finished
250 * @param ca_result the service handle returned from GNUNET_TESTBED_ConnectAdapter()
251 * @param emsg error message in case the operation has failed; will be NULL if
252 * operation has executed successfully.
255 service_connect_comp (void *cls,
256 struct GNUNET_TESTBED_Operation *op,
260 struct PeerGetStatsContext *peer_sc = cls;
261 struct GNUNET_STATISTICS_Handle *h = ca_result;
263 LOG_DEBUG ("Retrieving statistics of peer %u\n",
264 peer_sc->peer_index);
265 peer_sc->get_handle =
266 GNUNET_STATISTICS_get (h, peer_sc->sc->subsystem,
268 &iteration_completion_cb,
269 iterator_cb, peer_sc);
274 * Adapter function called to establish a connection to the statistics service
277 * @param cls the PeerGetStatsContext
278 * @param cfg configuration of the peer to connect to; will be available until
279 * GNUNET_TESTBED_operation_done() is called on the operation returned
280 * from GNUNET_TESTBED_service_connect()
281 * @return service handle to return in 'op_result', NULL on error
284 statistics_ca (void *cls, const struct GNUNET_CONFIGURATION_Handle *cfg)
286 struct PeerGetStatsContext *peer_sc = cls;
288 LOG_DEBUG ("Connecting to statistics service of peer %u\n",
289 peer_sc->peer_index);
290 return GNUNET_STATISTICS_create ("<testbed-api>", cfg);
295 * Adapter function called to destroy statistics connection
297 * @param cls the PeerGetStatsContext
298 * @param op_result service handle returned from the connect adapter
301 statistics_da (void *cls, void *op_result)
303 struct PeerGetStatsContext *peer_sc = cls;
304 struct GNUNET_STATISTICS_Handle *sh = op_result;
306 if (NULL != peer_sc->get_handle)
308 GNUNET_STATISTICS_get_cancel (peer_sc->get_handle);
309 peer_sc->get_handle = NULL;
311 GNUNET_STATISTICS_destroy (sh, GNUNET_NO);
312 if (NULL != peer_sc->op_done_task_id)
313 GNUNET_SCHEDULER_cancel (peer_sc->op_done_task_id);
314 GNUNET_free (peer_sc);
319 * Function called when get_statistics operation is ready
321 * @param cls the GetStatsContext
324 opstart_get_stats (void *cls)
326 struct GetStatsContext *sc = cls;
327 struct PeerGetStatsContext *peer_sc;
330 LOG_DEBUG ("Starting get_statistics operation\n");
331 sc->ops = GNUNET_malloc (sc->num_peers *
332 sizeof (struct GNUNET_TESTBED_Operation *));
333 for (peer = 0; peer < sc->num_peers; peer++)
335 if (NULL == sc->peers[peer])
340 peer_sc = GNUNET_new (struct PeerGetStatsContext);
342 peer_sc->peer_index = peer;
344 GNUNET_TESTBED_service_connect (sc, sc->peers[peer], "statistics",
345 &service_connect_comp,
355 * Function called when get_statistics operation is cancelled or marked as done
357 * @param cls the GetStatsContext
360 oprelease_get_stats (void *cls)
362 struct GetStatsContext *sc = cls;
365 LOG_DEBUG ("Cleaning up get_statistics operation\n");
366 if (NULL != sc->call_completion_task_id)
367 GNUNET_SCHEDULER_cancel (sc->call_completion_task_id);
370 for (peer = 0; peer < sc->num_peers; peer++)
372 if (NULL != sc->ops[peer])
374 GNUNET_TESTBED_operation_done (sc->ops[peer]);
375 sc->ops[peer] = NULL;
378 GNUNET_free (sc->ops);
380 GNUNET_free_non_null (sc->subsystem);
381 GNUNET_free_non_null (sc->name);
384 GNUNET_TESTBED_operation_queue_destroy_empty_ (no_wait_queue))
385 no_wait_queue = NULL;
390 * Convenience method that iterates over all (running) peers
391 * and retrieves all statistics from each peer.
393 * @param num_peers number of peers to iterate over
394 * @param peers array of peers to iterate over
395 * @param subsystem limit to the specified subsystem, NULL for all subsystems
396 * @param name name of the statistic value, NULL for all values
397 * @param proc processing function for each statistic retrieved
398 * @param cont continuation to call once call is completed(?)
399 * @param cls closure to pass to proc and cont
400 * @return operation handle to cancel the operation
402 struct GNUNET_TESTBED_Operation *
403 GNUNET_TESTBED_get_statistics (unsigned int num_peers,
404 struct GNUNET_TESTBED_Peer **peers,
405 const char *subsystem, const char *name,
406 GNUNET_TESTBED_StatisticsIterator proc,
407 GNUNET_TESTBED_OperationCompletionCallback cont,
410 struct GetStatsContext *sc;
412 GNUNET_assert (NULL != proc);
413 GNUNET_assert (NULL != cont);
414 if (NULL == no_wait_queue)
415 no_wait_queue = GNUNET_TESTBED_operation_queue_create_
416 (OPERATION_QUEUE_TYPE_FIXED, UINT_MAX);
417 sc = GNUNET_new (struct GetStatsContext);
419 sc->subsystem = (NULL == subsystem) ? NULL : GNUNET_strdup (subsystem);
420 sc->name = (NULL == name) ? NULL : GNUNET_strdup (name);
424 sc->num_peers = num_peers;
426 GNUNET_TESTBED_operation_create_ (sc, &opstart_get_stats,
427 &oprelease_get_stats);
428 GNUNET_TESTBED_operation_queue_insert_ (no_wait_queue, sc->main_op);
429 GNUNET_TESTBED_operation_begin_wait_ (sc->main_op);
434 /* end of testbed_api_statistics.c */