2 This file is part of GNUnet.
3 Copyright (C) 2008--2013, 2016 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_barriers.c
23 * @brief API implementation for testbed barriers
24 * @author Sree Harsha Totakura <sreeharsha@totakura.in>
27 #include "gnunet_testbed_service.h"
28 #include "testbed_api.h"
33 #define LOG(type, ...) \
34 GNUNET_log_from (type, "testbed-api-barriers", __VA_ARGS__);
37 * Debug logging shorthand
39 #define LOG_DEBUG(...) \
40 LOG (GNUNET_ERROR_TYPE_DEBUG, __VA_ARGS__);
46 struct GNUNET_TESTBED_BarrierWaitHandle
49 * The name of the barrier
54 * Then configuration used for the client connection
56 struct GNUNET_CONFIGURATION_Handle *cfg;
59 * The testbed-barrier service message queue.
61 struct GNUNET_MQ_Handle *mq;
64 * The barrier wait callback
66 GNUNET_TESTBED_barrier_wait_cb cb;
69 * The closure for @e cb.
77 * Check if barrier status message is well-formed.
80 * @param msg received message
81 * @return #GNUNET_OK if the message is well-formed.
84 check_status (void *cls,
85 const struct GNUNET_TESTBED_BarrierStatusMsg *msg)
87 /* FIXME: this fails to actually check that the message
88 follows the protocol spec (0-terminations!). However,
89 not critical as #handle_status() doesn't interpret the
90 variable-size part anyway right now. */
96 * Type of a function to call when we receive a message
100 * @param msg received message
103 handle_status (void *cls,
104 const struct GNUNET_TESTBED_BarrierStatusMsg *msg)
106 struct GNUNET_TESTBED_BarrierWaitHandle *h = cls;
108 switch (ntohs (msg->status))
110 case GNUNET_TESTBED_BARRIERSTATUS_ERROR:
115 case GNUNET_TESTBED_BARRIERSTATUS_INITIALISED:
121 case GNUNET_TESTBED_BARRIERSTATUS_CROSSED:
133 GNUNET_TESTBED_barrier_wait_cancel (h);
138 * Generic error handler, called with the appropriate error code and
139 * the same closure specified at the creation of the message queue.
140 * Not every message queue implementation supports an error handler.
142 * @param cls closure with the `struct GNUNET_TESTBED_BarrierWaitHandle *`
143 * @param error error code
146 mq_error_handler (void *cls,
147 enum GNUNET_MQ_Error error)
149 struct GNUNET_TESTBED_BarrierWaitHandle *h = cls;
154 GNUNET_TESTBED_barrier_wait_cancel (h);
159 * Wait for a barrier to be crossed. This function should be called by the
160 * peers which have been started by the testbed. If the peer is not started by
161 * testbed this function may return error
163 * @param name the name of the barrier
164 * @param cb the barrier wait callback
165 * @param cb_cls the closure for @a cb
166 * @return barrier wait handle which can be used to cancel the waiting at
167 * anytime before the callback is called. NULL upon error.
169 struct GNUNET_TESTBED_BarrierWaitHandle *
170 GNUNET_TESTBED_barrier_wait (const char *name,
171 GNUNET_TESTBED_barrier_wait_cb cb,
174 GNUNET_MQ_hd_var_size (status,
175 GNUNET_MESSAGE_TYPE_TESTBED_BARRIER_STATUS,
176 struct GNUNET_TESTBED_BarrierStatusMsg);
177 struct GNUNET_TESTBED_BarrierWaitHandle *h
178 = GNUNET_new (struct GNUNET_TESTBED_BarrierWaitHandle);
179 struct GNUNET_MQ_MessageHandler handlers[] = {
180 make_status_handler (h),
181 GNUNET_MQ_handler_end ()
183 struct GNUNET_MQ_Envelope *env;
184 struct GNUNET_TESTBED_BarrierWait *msg;
185 const char *cfg_filename;
188 GNUNET_assert (NULL != cb);
189 cfg_filename = getenv (ENV_TESTBED_CONFIG);
190 if (NULL == cfg_filename)
192 LOG (GNUNET_ERROR_TYPE_ERROR,
193 "Are you running under testbed?\n");
197 h->cfg = GNUNET_CONFIGURATION_create ();
199 GNUNET_CONFIGURATION_load (h->cfg,
202 LOG (GNUNET_ERROR_TYPE_ERROR,
203 "Unable to load configuration from file `%s'\n",
205 GNUNET_CONFIGURATION_destroy (h->cfg);
209 h->name = GNUNET_strdup (name);
212 h->mq = GNUNET_CLIENT_connecT (h->cfg,
219 LOG (GNUNET_ERROR_TYPE_ERROR,
220 "Unable to connect to local testbed-barrier service\n");
221 GNUNET_TESTBED_barrier_wait_cancel (h);
224 name_len = strlen (name); /* NOTE: unusual to not have 0-termination, change? */
225 env = GNUNET_MQ_msg_extra (msg,
227 GNUNET_MESSAGE_TYPE_TESTBED_BARRIER_WAIT);
231 GNUNET_MQ_send (h->mq,
238 * Cancel a barrier wait handle
240 * @param h the barrier wait handle
243 GNUNET_TESTBED_barrier_wait_cancel (struct GNUNET_TESTBED_BarrierWaitHandle *h)
247 GNUNET_MQ_destroy (h->mq);
250 GNUNET_free (h->name);
251 GNUNET_CONFIGURATION_destroy (h->cfg);
255 /* end of testbed_api_barriers.c */