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 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/>.
18 SPDX-License-Identifier: AGPL3.0-or-later
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 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
109 "Got barrier status %d\n",
110 (int) ntohs (msg->status));
111 switch (ntohs (msg->status))
113 case GNUNET_TESTBED_BARRIERSTATUS_ERROR:
119 case GNUNET_TESTBED_BARRIERSTATUS_INITIALISED:
126 case GNUNET_TESTBED_BARRIERSTATUS_CROSSED:
139 GNUNET_TESTBED_barrier_wait_cancel (h);
144 * Generic error handler, called with the appropriate error code and
145 * the same closure specified at the creation of the message queue.
146 * Not every message queue implementation supports an error handler.
148 * @param cls closure with the `struct GNUNET_TESTBED_BarrierWaitHandle *`
149 * @param error error code
152 mq_error_handler (void *cls,
153 enum GNUNET_MQ_Error error)
155 struct GNUNET_TESTBED_BarrierWaitHandle *h = cls;
160 GNUNET_TESTBED_barrier_wait_cancel (h);
165 * Wait for a barrier to be crossed. This function should be called by the
166 * peers which have been started by the testbed. If the peer is not started by
167 * testbed this function may return error
169 * @param name the name of the barrier
170 * @param cb the barrier wait callback
171 * @param cb_cls the closure for @a cb
172 * @return barrier wait handle which can be used to cancel the waiting at
173 * anytime before the callback is called. NULL upon error.
175 struct GNUNET_TESTBED_BarrierWaitHandle *
176 GNUNET_TESTBED_barrier_wait (const char *name,
177 GNUNET_TESTBED_barrier_wait_cb cb,
180 struct GNUNET_TESTBED_BarrierWaitHandle *h
181 = GNUNET_new (struct GNUNET_TESTBED_BarrierWaitHandle);
182 struct GNUNET_MQ_MessageHandler handlers[] = {
183 GNUNET_MQ_hd_var_size (status,
184 GNUNET_MESSAGE_TYPE_TESTBED_BARRIER_STATUS,
185 struct GNUNET_TESTBED_BarrierStatusMsg,
187 GNUNET_MQ_handler_end ()
189 struct GNUNET_MQ_Envelope *env;
190 struct GNUNET_TESTBED_BarrierWait *msg;
191 const char *cfg_filename;
194 GNUNET_assert (NULL != cb);
195 cfg_filename = getenv (ENV_TESTBED_CONFIG);
196 if (NULL == cfg_filename)
198 LOG (GNUNET_ERROR_TYPE_ERROR,
199 "Are you running under testbed?\n");
203 h->cfg = GNUNET_CONFIGURATION_create ();
205 GNUNET_CONFIGURATION_load (h->cfg,
208 LOG (GNUNET_ERROR_TYPE_ERROR,
209 "Unable to load configuration from file `%s'\n",
211 GNUNET_CONFIGURATION_destroy (h->cfg);
215 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
216 "Waiting on barrier `%s'\n",
218 h->name = GNUNET_strdup (name);
221 h->mq = GNUNET_CLIENT_connect (h->cfg,
228 LOG (GNUNET_ERROR_TYPE_ERROR,
229 "Unable to connect to local testbed-barrier service\n");
230 GNUNET_TESTBED_barrier_wait_cancel (h);
233 name_len = strlen (name); /* NOTE: unusual to not have 0-termination, change? */
234 env = GNUNET_MQ_msg_extra (msg,
236 GNUNET_MESSAGE_TYPE_TESTBED_BARRIER_WAIT);
237 GNUNET_memcpy (msg->name,
240 GNUNET_MQ_send (h->mq,
247 * Cancel a barrier wait handle
249 * @param h the barrier wait handle
252 GNUNET_TESTBED_barrier_wait_cancel (struct GNUNET_TESTBED_BarrierWaitHandle *h)
256 GNUNET_MQ_destroy (h->mq);
259 GNUNET_free (h->name);
260 GNUNET_CONFIGURATION_destroy (h->cfg);
264 /* end of testbed_api_barriers.c */